Skip to content

bsn: improve docs and add tests#24464

Draft
laundmo wants to merge 8 commits into
bevyengine:mainfrom
laundmo:bsn-better-docs
Draft

bsn: improve docs and add tests#24464
laundmo wants to merge 8 commits into
bevyengine:mainfrom
laundmo:bsn-better-docs

Conversation

@laundmo
Copy link
Copy Markdown
Member

@laundmo laundmo commented May 27, 2026

Objective

Improve documentation of bevy_scene/bsn.

Rendered: https://share.yadamiel.com/docs/doc/bevy/

Closes: #24299

Solution

This PR depends on/includes changes from

Docs changes (approx)

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

@laundmo laundmo changed the title progress on docs bsn: improve docs and add tests May 27, 2026
@alice-i-cecile alice-i-cecile added this to the 0.19 milestone May 27, 2026
//! - Do you need the "required" components to be automatically added in non-scene contexts? Use required components.
//! - Is spawn performance a very high priority? Use required components.
//!
//! ## .bsn Asset Format
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: somehow mention users can implement it

@laundmo laundmo force-pushed the bsn-better-docs branch from 6c84495 to afba143 Compare May 28, 2026 12:54
@laundmo
Copy link
Copy Markdown
Member Author

laundmo commented May 29, 2026

Note to self: Document #24469

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation C-Code-Quality A section of code that is hard to understand or change A-Scenes Composing and serializing ECS objects labels May 31, 2026
@alice-i-cecile alice-i-cecile self-requested a review May 31, 2026 16:37
@alice-i-cecile alice-i-cecile added the S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged label May 31, 2026
@alice-i-cecile alice-i-cecile requested a review from cart May 31, 2026 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Scenes Composing and serializing ECS objects C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

move bsn!/bsn_list! macro docs to bevy_scene crate re-export location to enable doc-links

2 participants