Skip to content

Conversation

@Fodesu
Copy link
Contributor

@Fodesu Fodesu commented Jan 16, 2026

@github-actions
Copy link
Contributor

The generated examples/README.md is out of sync with the example metadata in Cargo.toml or the example readme template. Please run cargo run -p build-templated-pages -- update examples to update it, and commit the file change.

@homebrewmellow
Copy link

haha, i needed that an hour ago

@IQuick143 IQuick143 added C-Examples An addition or correction to our examples A-UI Graphical user interfaces, styles, layouts, and widgets labels Jan 17, 2026
@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 Jan 18, 2026
@ickshonpe
Copy link
Contributor

I think this would be better with a separate PR for each example. Particularly the advanced example probably will require closer examination etc, and would hold up merging the other two.

@Fodesu Fodesu changed the title add examples for ImageNode add basic examples for ImageNode Jan 19, 2026
@Fodesu Fodesu marked this pull request as ready for review January 19, 2026 14:58
@Fodesu
Copy link
Contributor Author

Fodesu commented Jan 19, 2026

I think this would be better with a separate PR for each example. Particularly the advanced example probably will require closer examination etc, and would hold up merging the other two.

ok. this PR is a basic example for ImageNode. I have almost completed the advanced example for ImageNode.

@alice-i-cecile alice-i-cecile added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jan 19, 2026
Copy link
Contributor

@it-me-joda it-me-joda left a comment

Choose a reason for hiding this comment

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

Seeing as this is the most basic example I would expect to see more comprehensive comments about why for example you need a parent node rather than just top leveling an image node.

@alice-i-cecile alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 20, 2026
@Fodesu Fodesu requested a review from it-me-joda January 20, 2026 07:51
Copy link
Contributor

@it-me-joda it-me-joda left a comment

Choose a reason for hiding this comment

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

Super straightforward doc suggestions to be a little more informative and give a little more context to how this works. My general idea is that sometimes people will just skip comment to comment and giving them more places to stop and see key features with a more contextual example is good especially in the basic examples where someone is likely to be very new to the Bevy ecosystem.

My headspace is like, if I were on a tour in some museum without a guide I wouldn't know what matters and where to look and what big things are hiding in plain sight. But with a good tour guide, I can have a much more lucrative information gathering experience. When we write comments in examples we should be good tour guides and hopefully if someone needs more context or clarification then we'll hear about it in an issue or Discord or something so we can make it even better.

}

fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
// ui camera
Copy link
Contributor

Choose a reason for hiding this comment

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

This one is super nitpicky

Suggested change
// ui camera
// UI camera

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I noticed that example in the repository already have the first letter not capitalized. Is it necessary to modify them?

Copy link
Contributor

@it-me-joda it-me-joda left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jan 20, 2026
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 20, 2026
Merged via the queue into bevyengine:main with commit b55363e Jan 20, 2026
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-UI Graphical user interfaces, styles, layouts, and widgets C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants