mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 06:22:01 +00:00
2012f13c05
# Objective - The [developer docs](https://dev-docs.bevyengine.org) are primarily used by developers, who often deal with internal and private functions. - @mweatherley suggested [on Discord](https://discord.com/channels/691052431525675048/743559241461399582/1273658470134186112) that CI passes `--document-private-items` to the dev-docs, so contributors can easily browse these internal details. ## Solution - Add `--document-private-items` to the CI job that builds the dev-docs. ## Testing - It should run in CI and generate documentation for private code. ## Drawbacks - Users that track the main branch may use the dev-docs instead of <https://docs.rs/bevy>, which may now show a lot of unwanted internal details. - Searching may be slower / bloated with internal details. |
||
|---|---|---|
| .. | ||
| actions/install-linux-deps | ||
| contributing | ||
| example-run | ||
| ISSUE_TEMPLATE | ||
| linters | ||
| start-mobile-example | ||
| start-wasm-example | ||
| workflows | ||
| dependabot.yml | ||
| FUNDING.yml | ||
| pull_request_template.md | ||