diff --git a/bevy_lint/docs/release.md b/bevy_lint/docs/release.md index 698df0cc..943871ae 100644 --- a/bevy_lint/docs/release.md +++ b/bevy_lint/docs/release.md @@ -21,6 +21,12 @@ ````markdown +You can find the live documentation for this release [here](https://thebevyflock.github.io/bevy_cli/bevy_lint/). + +> [!WARNING] +> +> This is an unofficial community project, hacked upon by the Bevy CLI working group until it is eventually upstreamed into the main [Bevy Engine organization](https://github.com/bevyengine). Pardon our rough edges, and please consider [submitting an issue](https://github.com/TheBevyFlock/bevy_cli/issues) if you run into trouble! + This release uses the toolchain, based on Rust . You can install it from Git with the following commands: @@ -39,7 +45,7 @@ rustup run nightly-YYYY-MM-DD cargo install \ bevy_lint ``` - + ```` 5. Check the pre-release box if this is an alpha release, then click "Publish release"! @@ -58,5 +64,6 @@ rustup run nightly-YYYY-MM-DD cargo install \ ``` 2. Bump the version in [`Cargo.toml`](../Cargo.toml) to the next `-dev` version, and ensure [`Cargo.lock`](../../Cargo.lock) also updates. -3. Commit all of these changes and open a pull request. -4. Merge the PR after it has been approved, unblocking frozen pull requests. +3. Add a new row to the compatibility table for the new `-dev` version in [`README.md`](../README.md). +4. Commit all of these changes and open a pull request. +5. Merge the PR after it has been approved, unblocking frozen pull requests.