Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cover 0.7 docs improvements #6

Merged
merged 4 commits into from
Apr 14, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions content/news/2022-04-12-bevy-0.7/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ As always, there are a _ton_ of new features, bug fixes, and quality of life twe
* Render to texture: cameras can now be configured to render to a texture instead of a window
* Flexible user-customizable mesh vertex layouts in shaders
* ECS improvements: Order systems using their names, Query::get_many, use conflicting parameters in systems via ParamSets, WorldQuery derives
* Documentation improvements: better examples, more doc tests and more coverage
* More audio control: pause, volume, speed, and looping
* Hot reloading for "plugin-provided / built-in assets"
* Power usage options to enable only updating Bevy Apps when input occurs
Expand Down Expand Up @@ -370,6 +371,39 @@ fn despawn_players(mut players: Query<(Entity, PlayerQuery)>) {
}
```

## Documentation improvements

<div class="release-feature-authors">authors: @alice-i-cecile and many more</div>

Great docs make learning, using and building Bevy better.
But as a young engine, they're still a work-in-progress.

### deny-missing-docs

Our docs team (led by `@alice-i-cecile`) has started to [systematically fix that](https://github.com/bevyengine/bevy/issues/3492), with the help of Rust's `#[warn(missing_docs)]` lint.
Since 0.6, we've fully documented (and prevented doc-regressions for):

* `bevy_tasks` by `@james7132`
* `bevy_app` by `@dbearden`
* `bevy_dylib` by `@KDecay`
* `bevy_internal` by `@sheepyhead`

There have been [many other doc improvements](https://github.com/bevyengine/bevy/pulls?q=is%3Apr+is%3Aclosed+label%3AC-Docs) over this time period as well, including the addition of many helpful [doc tests](https://doc.rust-lang.org/rustdoc/documentation-tests.html), and our bar for docs in new code continues to rise.
A huge thanks to everyone making Bevy's docs better.

### New contributors

If you're [interested in contributing](https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md), the docs team is always ready to help new contributors get their first Bevy PR merged ASAP.
There have been a _ton_ of new contributors who've helped out with docs, either as a writer or a reviewer.
If this is you: thanks!

### Better examples

For many people, the best way to learn a tool is to see it in action.
We've been steadily polishing our [examples](https://github.com/bevyengine/bevy/tree/latest/examples):
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved
better explanations, more coverage, and higher code quality.
If you're new to Bevy, check out the much-improved [Breakout example](https://github.com/bevyengine/bevy/blob/latest/examples/games/breakout.rs)!
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved

## Support Bevy

Sponsorships help make my full time work on Bevy sustainable. If you believe in Bevy's mission, consider sponsoring me (@cart) ... every bit helps!
Expand Down