Conversation
There was a problem hiding this comment.
Pull request overview
Adds the Docusaurus documentation entry for the 9.4 release (currently written as 9.4.0-rc.30) so it appears in the releases section of the docs site.
Changes:
- Add release notes document for Release
9.4.0-rc.30, including migrations, highlights, and a categorized change list. - Add the Docusaurus category metadata for the new
Release 9.4docs section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| docs/docusaurus/docs/08-releases/06-release-9.4/release-9.4.0.md | Introduces the Release 9.4 notes content (migrations/highlights/full change list). |
| docs/docusaurus/docs/08-releases/06-release-9.4/category.yml | Adds sidebar category label/position for the Release 9.4 section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 🔄 Migrations | ||
|
|
||
| ### 🐞 Admin Portal > Reports > Timezone shown is not showing timezone | ||
| In order to see the change the default receipt template ballot_receipt_user.hbs needs some changes. |
There was a problem hiding this comment.
Grammar: add punctuation/rewording to improve readability (e.g., add a comma after “change” and avoid “needs some changes”).
| In order to see the change the default receipt template ballot_receipt_user.hbs needs some changes. | |
| To see the change, update the default receipt template `ballot_receipt_user.hbs` as follows. |
| Additionally, this includes creating developer documentation for managing Rust versions and third-party dependencies, plus implementing tooling for dependency auditing and reporting. | ||
| ### Main PRs | ||
| - https://github.com/sequentech/step/pull/1988 | ||
| - https://github.com/sequentech/step/pull/2150 | ||
| - https://github.com/sequentech/step/pull/2153 | ||
| ### Stable PRs |
There was a problem hiding this comment.
Within this list item, the continuation paragraph and the “Main PRs” sub-list are not indented, so they’ll render outside the bullet (breaking the structure). Indent the continuation lines/headings/links so they remain part of the same bullet item.
| Additionally, this includes creating developer documentation for managing Rust versions and third-party dependencies, plus implementing tooling for dependency auditing and reporting. | |
| ### Main PRs | |
| - https://github.com/sequentech/step/pull/1988 | |
| - https://github.com/sequentech/step/pull/2150 | |
| - https://github.com/sequentech/step/pull/2153 | |
| ### Stable PRs | |
| Additionally, this includes creating developer documentation for managing Rust versions and third-party dependencies, plus implementing tooling for dependency auditing and reporting. | |
| ### Main PRs | |
| - https://github.com/sequentech/step/pull/1988 | |
| - https://github.com/sequentech/step/pull/2150 | |
| - https://github.com/sequentech/step/pull/2153 | |
| ### Stable PRs |
| 1. **Rust Version**: All developers must use Rust 1.90.0. Run `rustc --version` in `devenv shell` to verify. | ||
| 2. **Dependency Updates**: After pulling this branch, run: | ||
| ```bash | ||
| devenv shell | ||
| cd packages/ | ||
| cargo build | ||
| ``` | ||
| 3. **Frontend Updates**: For frontend work: | ||
| ```bash | ||
| cd packages/ | ||
| yarn install | ||
| ``` | ||
| 4. **ESLint Migration**: Projects now use flat config (`eslint.config.js`). Old `.eslintrc.json` files have been removed. | ||
| 5. **New Documentation**: Review the new developer documentation: | ||
| - `docs/docusaurus/docs/developers/11-Updates/updating-rust-version.md` | ||
| - `docs/docusaurus/docs/reference/third_party_deps/third_party_deps.md` | ||
| - `docs/docusaurus/docs/developers/03-Development-Environment/nvd-api-key-setup.md` |
There was a problem hiding this comment.
The numbered “For Developers” steps and the fenced code block are not indented under the parent bullet, so Markdown will treat them as a separate top-level list/code block. Indent the numbered list and its code fences so they are nested under the “Migration” section for this item.
| 1. **Rust Version**: All developers must use Rust 1.90.0. Run `rustc --version` in `devenv shell` to verify. | |
| 2. **Dependency Updates**: After pulling this branch, run: | |
| ```bash | |
| devenv shell | |
| cd packages/ | |
| cargo build | |
| ``` | |
| 3. **Frontend Updates**: For frontend work: | |
| ```bash | |
| cd packages/ | |
| yarn install | |
| ``` | |
| 4. **ESLint Migration**: Projects now use flat config (`eslint.config.js`). Old `.eslintrc.json` files have been removed. | |
| 5. **New Documentation**: Review the new developer documentation: | |
| - `docs/docusaurus/docs/developers/11-Updates/updating-rust-version.md` | |
| - `docs/docusaurus/docs/reference/third_party_deps/third_party_deps.md` | |
| - `docs/docusaurus/docs/developers/03-Development-Environment/nvd-api-key-setup.md` | |
| 1. **Rust Version**: All developers must use Rust 1.90.0. Run `rustc --version` in `devenv shell` to verify. | |
| 2. **Dependency Updates**: After pulling this branch, run: | |
| ```bash | |
| devenv shell | |
| cd packages/ | |
| cargo build | |
| ``` | |
| 3. **Frontend Updates**: For frontend work: | |
| ```bash | |
| cd packages/ | |
| yarn install | |
| ``` | |
| 4. **ESLint Migration**: Projects now use flat config (`eslint.config.js`). Old `.eslintrc.json` files have been removed. | |
| 5. **New Documentation**: Review the new developer documentation: | |
| - `docs/docusaurus/docs/developers/11-Updates/updating-rust-version.md` | |
| - `docs/docusaurus/docs/reference/third_party_deps/third_party_deps.md` | |
| - `docs/docusaurus/docs/developers/03-Development-Environment/nvd-api-key-setup.md` |
| - https://github.com/sequentech/step/pull/2150 | ||
| - https://github.com/sequentech/step/pull/2153 | ||
| ### Stable PRs | ||
| - [x] Mark if not applicable |
There was a problem hiding this comment.
The “Stable PRs” section still contains a template placeholder (- [x] Mark if not applicable). For published release notes, this should be replaced with actual stable PR links or removed entirely.
| - [x] Mark if not applicable | |
| - None. |
| <span class="value" class="timestamp-content">{{timestamp}}</span> | ||
| ``` | ||
| To | ||
| ``` | ||
| <span class="value" class="timestamp-content">{{datetime from_rfc3339=timestamp output_format="%B %d, %Y %H:%M GMT %:z"}}</span> |
There was a problem hiding this comment.
The HTML example is invalid because it repeats the class attribute (class="value" class="timestamp-content"). Use a single class attribute with both classes so users can apply the migration safely.
| See [sequentech/meta#6191](https://github.com/sequentech/meta/issues/6191) for details. | ||
|
|
||
| ### 📖 [doc] Adding a section: `Reference/Third-Party Libraries` | ||
| ### For Developers |
There was a problem hiding this comment.
The “For Developers” heading is currently the same level (###) as the migration item heading above it, which makes the structure confusing. Consider making it a subheading (e.g., #### For Developers) or converting it to bold text under the migration item.
| ### For Developers | |
| #### For Developers |
| From | ||
| ``` | ||
| <span class="value" class="timestamp-content">{{timestamp}}</span> | ||
| ``` | ||
| To | ||
| ``` | ||
| <span class="value" class="timestamp-content">{{datetime from_rfc3339=timestamp output_format="%B %d, %Y %H:%M GMT %:z"}}</span> | ||
| ``` |
There was a problem hiding this comment.
This migration block is inside a bullet, but the following lines (“From” / code fence / “To”) are not indented, so Markdown will likely break the list formatting. Indent the nested content (including the fenced code blocks) so it renders as part of the bullet item.
| From | |
| ``` | |
| <span class="value" class="timestamp-content">{{timestamp}}</span> | |
| ``` | |
| To | |
| ``` | |
| <span class="value" class="timestamp-content">{{datetime from_rfc3339=timestamp output_format="%B %d, %Y %H:%M GMT %:z"}}</span> | |
| ``` | |
| From |
{{timestamp}}
To
{{datetime from_rfc3339=timestamp output_format="%B %d, %Y %H:%M GMT %:z"}}
| <span class="value" class="timestamp-content">{{timestamp}}</span> | ||
| ``` | ||
| To | ||
| ``` | ||
| <span class="value" class="timestamp-content">{{datetime from_rfc3339=timestamp output_format="%B %d, %Y %H:%M GMT %:z"}}</span> |
There was a problem hiding this comment.
The code examples here still use an invalid HTML pattern (duplicate class attributes). Update both the “From” and “To” snippets to use a single class attribute containing both classes.
| ### Stable PRs | ||
| - [x] Mark if not applicable | ||
|
|
||
| **Migration:** ### For Developers |
There was a problem hiding this comment.
Markdown formatting: **Migration:** ### For Developers combines a bold label with a heading marker, which will not render as intended. Split this into a plain “Migration:” label and a separate (properly indented) heading or sentence.
| **Migration:** ### For Developers | |
| Migration: For Developers |
| by @BelSequent | ||
|
|
||
|
|
||
| - 🐞 Admin Portal: Heterogeneus use of name/alias ([sequentech/step#2499](https://github.com/sequentech/step/pull/2499)) |
There was a problem hiding this comment.
Typo: “Heterogeneus” should be “Heterogeneous”.
| - 🐞 Admin Portal: Heterogeneus use of name/alias ([sequentech/step#2499](https://github.com/sequentech/step/pull/2499)) | |
| - 🐞 Admin Portal: Heterogeneous use of name/alias ([sequentech/step#2499](https://github.com/sequentech/step/pull/2499)) |
|
Parent issue: https://github.com/sequentech/meta/issues/10254