Skip to content

✨ Release 9.4 Documentation#2571

Merged
Findeton merged 3 commits intomainfrom
doc/feat-10254/main
Apr 18, 2026
Merged

✨ Release 9.4 Documentation#2571
Findeton merged 3 commits intomainfrom
doc/feat-10254/main

Conversation

@Findeton
Copy link
Copy Markdown
Contributor

@Findeton Findeton self-assigned this Mar 30, 2026
@Findeton Findeton added the documentation Improvements or additions to documentation label Mar 30, 2026
Copilot AI review requested due to automatic review settings March 30, 2026 13:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.4 docs 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.
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

Grammar: add punctuation/rewording to improve readability (e.g., add a comma after “change” and avoid “needs some changes”).

Suggested change
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.

Copilot uses AI. Check for mistakes.
Comment on lines +227 to +232
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
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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

Copilot uses AI. Check for mistakes.
Comment on lines +236 to +252
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`
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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`

Copilot uses AI. Check for mistakes.
- https://github.com/sequentech/step/pull/2150
- https://github.com/sequentech/step/pull/2153
### Stable PRs
- [x] Mark if not applicable
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
- [x] Mark if not applicable
- None.

Copilot uses AI. Check for mistakes.
Comment on lines +17 to +21
<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>
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
See [sequentech/meta#6191](https://github.com/sequentech/meta/issues/6191) for details.

### 📖 [doc] Adding a section: `Reference/Third-Party Libraries`
### For Developers
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
### For Developers
#### For Developers

Copilot uses AI. Check for mistakes.
Comment on lines +154 to +161
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>
```
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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"}}

Copilot uses AI. Check for mistakes.
Comment on lines +156 to +160
<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>
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
### Stable PRs
- [x] Mark if not applicable

**Migration:** ### For Developers
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
**Migration:** ### For Developers
Migration: For Developers

Copilot uses AI. Check for mistakes.
by @BelSequent


- 🐞 Admin Portal: Heterogeneus use of name/alias ([sequentech/step#2499](https://github.com/sequentech/step/pull/2499))
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

Typo: “Heterogeneus” should be “Heterogeneous”.

Suggested change
- 🐞 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))

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 30, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-04-18 11:44 UTC

@Findeton Findeton merged commit c059238 into main Apr 18, 2026
18 of 19 checks passed
@Findeton Findeton deleted the doc/feat-10254/main branch April 18, 2026 11:37
@Findeton Findeton changed the title ✨ Prepare Release 9.4 ✨ Release 9.4 Documentation Apr 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants