Improve documentation and tests on crates features
- Dominant language
- Rust
- Stars
- 48.2k
- Forks
- 4.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 171
Description
## How can Bevy's documentation be improved?
Bevy internal crates exposes many features, it can be hard to know which are often useful together for crate consumers. Those features and sets should be documented and tested in CI
- [ ] Document features in individual crates like they are on the top level Bevy crate
- [ ] Add [feature collections](https://github.com/bevyengine/bevy/pull/21472) for individual crates
- [ ] Add a command to CI script that will try to compile feature collections of a given crate / all crates
Contributor guide
Research direction
Start by reviewing how features are documented on the top-level Bevy crate and read the linked feature collections pull request. Then inspect the CI script to identify where a command could compile feature collections for one crate or all crates. Done means individual crate features are documented, feature collections are added, and CI checks them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- ci-cd, documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100