# Objective
Improve documentation of bevy_scene/bsn.
Rendered: https://share.yadamiel.com/docs/doc/bevy/scene/index.htmlCloses: #24299Closes: #24540Closes: #24541
## Solution
This PR depends on/includes changes from
- #24402
Docs changes (approx)
- removing confusing `Inheritance` concept in favour of caching
- #24367
- fix now-changed syntax
- #24367
- cleaning up the duplication between macro docs and module docs
- clean up the syntax snippet to be a single table
- a bunch of smaller fixes
## Testing
- `cargo doc -Zrustdoc-mergeable-info -p bevy_scene --lib` locally works
fine
- the other cargo doc command also works fine (see cargo.toml diff for
full command, its *ugh*)
## Todo
- [x] show how scenes actually get evaluated, not a full expansion but a
rough idea of it
- [ ] come up with something better for the macro inline docs than a
complex example macro call
- [x] probably remove the #24402 commits again, they're annoying to have
in the history
---------
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
# Objective
Follow up on resources-as-components.
Update trait tags in rustdoc-generated documentation:
- do not add component tag on resources, as that's offers no new
information
- mark immutable resources as immutable, like with component trait
## Testing
RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg
docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package
bevy_ecs
## Showcase
Before:
<img width="323" height="72" alt="Screenshot_20260509_233133"
src="https://github.com/user-attachments/assets/b0448b13-3ce0-4c6e-8c3b-9e91a0ba521f"
/>
After:
<img width="331" height="70" alt="Screenshot_20260509_233051"
src="https://github.com/user-attachments/assets/650d0adf-e075-4e67-98f0-41ac7bf30dfe"
/>
# Objective
The README in `docs-rs/` tells you to add this line to your
`Cargo.toml`:
```toml
[lints.rust]
unexpected_cfgs = { check-cfg = ['cfg(docsrs_dep)'] }
```
However this does not compile due to this error:
```
error: missing field `level`
--> Cargo.toml:41:19
|
41 | unexpected_cfgs = { check-cfg = ['cfg(docsrs_dep)'] }
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```
## Solution
Looking at Bevy's own `Cargo.toml`, this lint is used with the `warn`
level.
```toml
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(docsrs_dep)'] }
```
So I updated the docs.rs README to be the same.
## Testing
I copied and pasted the new snippet into my `Cargo.toml` and it worked.
# Objective
Fixes#18117
These are component subtraits, but unlike for `Event` (before that bound
got removed) this still shows it as a component because it's actually
used as such.
## Testing
```sh
RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package bevy_ecs
```
---
## Showcase
# Objective
Bevy's ECS provides several core traits such as `Component`,
`SystemParam`, etc that determine where a type can be used. When reading
the docs, this currently requires scrolling down to and scanning the
"Trait Implementations" section. Make these core traits more visible.
## Solution
Add a color-coded labels below the type heading denoting the following
types:
- `Component`
- immutable components are labeled as such
- `Resource`
- `Asset`
- `Event`
- `Plugin` & `PluginGroup`
- `ScheduleLabel` & `SystemSet`
- `SystemParam`
As docs.rs does not provide an option for post-processing the html,
these are added via JS with traits implementations being detected by
scanning the DOM. Rustdoc's html output is unstable, which could
potentially lead to this detection (or the adding of the labels) to
break, however it only needs to work when a new release is deployed and
falls back to the status quo of not displaying these labels.
Idea by JMS55, implementation by Jondolf (see
https://github.com/Jondolf/bevy_docs_extension_demo/).
## Testing
Run this in Bevy's root folder:
```bash
RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps -p <some_bevy_package>
```
---
## Showcase
Check it out on
[docs.rs](https://docs.rs/bevy_docs_extension_demo/0.1.1/bevy_docs_extension_demo/struct.TestAllTraits.html)
## Release Notes
On docs.rs, Bevy now displays labels indicating which core traits a type
implements:
If you want to add these to your own crate, check out [these
instructions](https://github.com/bevyengine/bevy/blob/main/docs-rs#3rd-party-crates).
---------
Co-authored-by: Joona Aalto <jondolf.dev@gmail.com>
Co-authored-by: Carter Weinberg <weinbergcarter@gmail.com>
laund