This directory contains drafts of documentation for the current development cycle, which will be published to the website during the next release. You can find more information in the release notes and migration guides files.
When it is time to start preparing the final release notes / migration guide over in bevy-website, use the following process:
- Check out the upcoming Bevy release branch in the
bevyrepo - Open a terminal, navigate to the
tools/export-contentfolder in thebevyrepo, and runcargo run. - Use the tool to easily reorder the release notes relative to each other
- After saving and exiting the tool, it will write
merged_release_notes.mdandmerged_migration_guides.mdto_release-content - Use these to create a release notes news article draft and a migration guide draft in
bevy-website.