Skip to content

Document bevy_scene requirement for example#916

Merged
Jondolf merged 3 commits intoavianphysics:mainfrom
Eterniance:collider-doc
Jan 31, 2026
Merged

Document bevy_scene requirement for example#916
Jondolf merged 3 commits intoavianphysics:mainfrom
Eterniance:collider-doc

Conversation

@Eterniance
Copy link
Contributor

Objective

Add the bevy_scene feature requirement in the ColliderConstructorHierarchy documentation example. Fixes #874.

@Jondolf Jondolf added A-Collision Relates to the broad phase, narrow phase, colliders, or other collision functionality C-Docs Improvements or additions to documentation D-Trivial Nice and straightforward! A great choice to get started with Avian labels Jan 31, 2026
Copy link
Member

@Jondolf Jondolf left a comment

Choose a reason for hiding this comment

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

So I think the relevant part here is that the type itself requires the bevy_scene feature for it to work on scenes, not that this specific example requires bevy_scene.

I pushed a commit to tweak the docs a bit and mention the bevy_scene requirement earlier on in the docs, in the section where it describes how the component interacts with SceneRoot :)

@Jondolf Jondolf enabled auto-merge (squash) January 31, 2026 23:33
@Jondolf Jondolf merged commit 0fc8ae0 into avianphysics:main Jan 31, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Collision Relates to the broad phase, narrow phase, colliders, or other collision functionality C-Docs Improvements or additions to documentation D-Trivial Nice and straightforward! A great choice to get started with Avian

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document bevy_scene requirement

2 participants