From 7217d6f440ca08d5958d278abc46d319ae218cc7 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Thu, 14 Apr 2022 15:55:16 -0400 Subject: [PATCH 1/3] Cover doc improvements for Bevy 0.7 --- content/news/2022-04-12-bevy-0.7/index.md | 24 +++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/content/news/2022-04-12-bevy-0.7/index.md b/content/news/2022-04-12-bevy-0.7/index.md index 696943016a..76f084da98 100644 --- a/content/news/2022-04-12-bevy-0.7/index.md +++ b/content/news/2022-04-12-bevy-0.7/index.md @@ -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 @@ -370,6 +371,29 @@ fn despawn_players(mut players: Query<(Entity, PlayerQuery)>) { } ``` +## Documentation improvements + +
authors: @alice-i-cecile and many more
+ +Great docs make learning, using and building Bevy better. +But as a young engine, they're still a work-in-progress. + +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 a huge number of [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). +A huge thanks to all of the contributors and reviewers who have helped make Bevy's docs better. + +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): +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)! + ## 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! From 24e82f9ab03b274846e91a8796fc521d26386e58 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Thu, 14 Apr 2022 16:06:36 -0400 Subject: [PATCH 2/3] Added shout-out to new contributors --- content/news/2022-04-12-bevy-0.7/index.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/content/news/2022-04-12-bevy-0.7/index.md b/content/news/2022-04-12-bevy-0.7/index.md index 76f084da98..f4901cd9e9 100644 --- a/content/news/2022-04-12-bevy-0.7/index.md +++ b/content/news/2022-04-12-bevy-0.7/index.md @@ -378,6 +378,8 @@ fn despawn_players(mut players: Query<(Entity, PlayerQuery)>) { 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): @@ -386,8 +388,16 @@ Since 0.6, we've fully documented (and prevented doc-regressions for): * `bevy_dylib` by `@KDecay` * `bevy_internal` by `@sheepyhead` -There have been a huge number of [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). -A huge thanks to all of the contributors and reviewers who have helped make Bevy's docs better. +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): From 22924b3a8a883e941c9273cab2c7b01c9a182adb Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Thu, 14 Apr 2022 16:14:20 -0400 Subject: [PATCH 3/3] : yeet --- content/news/2022-04-12-bevy-0.7/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/news/2022-04-12-bevy-0.7/index.md b/content/news/2022-04-12-bevy-0.7/index.md index f4901cd9e9..6b6c8da716 100644 --- a/content/news/2022-04-12-bevy-0.7/index.md +++ b/content/news/2022-04-12-bevy-0.7/index.md @@ -400,8 +400,7 @@ 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): -better explanations, more coverage, and higher code quality. +We've been steadily polishing our [examples](https://github.com/bevyengine/bevy/tree/latest/examples) with 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)! ## Support Bevy