Skip to content

Conversation

@doup
Copy link
Contributor

@doup doup commented Oct 25, 2024

  • Change migration_guides.rs so that it generates sorted _guides.toml each time
  • Add area sections in migration guides and improve styling
bevy-migration-guides.mp4

Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

I really like the effect. Thanks!

Copy link
Member

@TrialDragon TrialDragon left a comment

Choose a reason for hiding this comment

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

Site works still, and any major concerns I had regarding how the Migration Guides generator would work from purely code review have been thoroughly debunked after testing this, so from a purely functional standpoint I feel comfortable with this PR.

However, I still have changes to request for consideration regarding clear documentation of what has changed in the Migration Guides generator.

(Also, does the migration guide generator still need to be run for the 0.15 guides? Those ones have Without Area at the top instead of bottom from what I can see).

And, finally, purely an observation, nitpick, and bikeshed that'd be best suited for a potential follow-up; perhaps we should more blatantly style the scope of each area? Like, some sort of border containing them, or lighter background behind them? Something to make it clear where one area ends and another begins.

@doup
Copy link
Contributor Author

doup commented Oct 29, 2024

(Also, does the migration guide generator still need to be run for the 0.15 guides? Those ones have Without Area at the top instead of bottom from what I can see)

Yes, the command now always overwrites the file because if we pick a new migration guide we don't were it's going to be located (previously it appended); assuming the guides list is not sorted, we must run the command. But the operation is non-destructive as it'll read the file before and only add the entries that are missing.

And, finally, purely an observation, nitpick, and bikeshed that'd be best suited for a potential follow-up; perhaps we should more blatantly style the scope of each area? Like, some sort of border containing them, or lighter background behind them? Something to make it clear where one area ends and another begins.

hahaha, ok, I'm not sure if I'll like wrapping the whole area section in some border or background… but I'm open to be convinced otherwise; maybe we can make the section header sticky so it's always present while scrolling? 🤔

Copy link
Member

@TrialDragon TrialDragon left a comment

Choose a reason for hiding this comment

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

Lgtm now.

@TrialDragon TrialDragon added S-Ready-For-Final-Review Ready for a maintainer to consider for merging and removed S-Needs-Review labels Oct 29, 2024
@alice-i-cecile
Copy link
Member

Once CI is green I'll merge this @doup :)

@doup
Copy link
Contributor Author

doup commented Oct 30, 2024

Ooops… @alice-i-cecile now is fixed.

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 30, 2024
Merged via the queue into bevyengine:main with commit d204494 Oct 30, 2024
10 checks passed
@doup doup deleted the sort-migrations branch October 31, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Migration Guides C-Feature A new feature, making something new possible C-Usability C-Webdev D-Modest S-Ready-For-Final-Review Ready for a maintainer to consider for merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants