Skip to content

doc: restructure release notes#780

Open
gyrationtechs wants to merge 4 commits intomainfrom
doc/relnotes-restructure
Open

doc: restructure release notes#780
gyrationtechs wants to merge 4 commits intomainfrom
doc/relnotes-restructure

Conversation

@gyrationtechs
Copy link
Copy Markdown
Contributor

@gyrationtechs gyrationtechs commented Mar 31, 2026

Summary

This PR:

  • Restructures the release notes overview page.
  • Moves the environment section into a standalone doc.
  • Removes the compatibility matrix from the overview and adds a link to the support matrix doc.

@gyrationtechs gyrationtechs requested review from a team as code owners March 31, 2026 19:14
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 31, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
midnight-wiki Ready Ready Preview, Comment Apr 1, 2026 9:38am

Request Review

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 31, 2026 •
edited
Loading

Summary

Status Count
🔍 Total 24
✅ Successful 16
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 0
❓ Unknown 0
🚫 Errors 8
⛔ Unsupported 0

Errors per input

Errors in docs/relnotes/network.mdx

Errors in docs/relnotes/overview.mdx

  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/relnotes/network | Cannot find file
  • [ERROR] file:///home/runner/work/midnight-docs/midnight-docs/docs/relnotes/support-matrix | Cannot find file
    Full Github Actions output

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 31, 2026 •
edited
Loading

🚀 Preview Deployment

✅ Deployment Ready

🔗 Preview URL: https://pr-780-midnight-docs.vercel.app

📝 Latest commit: c8766ac
⏰ Updated: Apr 1, 2026, 9:38 AM UTC

This preview updates automatically when you push new commits to this PR.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 31, 2026

Deployment failed with the following error:

Invalid request: `attribution.gitUser` should NOT have additional property `isBot`.

DianaHackmamba
DianaHackmamba requested changes Mar 31, 2026
View reviewed changes
docs/relnotes/network.mdx

Use these endpoints to connect your DApp to Midnight Preview and Preprod environments.

## Preview
Copy link
Copy Markdown
Contributor

@DianaHackmamba DianaHackmamba Mar 31, 2026

Choose a reason for hiding this comment

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

Add a brief context paragraph before each table. Makes AI consumers happier.

docs/relnotes/overview.mdx Outdated
- **Faucet UI**: https://faucet.preprod.midnight.network/
- **Block Explorer**: https://explorer.preprod.midnight.network
- **cNgD DApp**: https://dust.preprod.midnight.network
Midnight uses dedicated network services such as RPC nodes, indexer API, and proof server to power DApp development and interaction across the Preview and Preprod environments. To connect your application and configure these services correctly, see the [environments and endpoints](./network) reference.
Copy link
Copy Markdown
Contributor

@DianaHackmamba DianaHackmamba Mar 31, 2026

Choose a reason for hiding this comment

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

Whenever possible, the link text should match the target title.

Copy link
Copy Markdown
Contributor Author

@gyrationtechs gyrationtechs Apr 1, 2026

Choose a reason for hiding this comment

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

Do you mean in terms of capitalization? Because the title is the same.

docs/relnotes/overview.mdx Outdated
| testkit-js | 4.0.2 |
| Block Explorer | 0.5.0 |
| Faucet | 0.11.8 |
To view the full list of components and their compatible versions, see the [compatibility matrix](./support-matrix).
Copy link
Copy Markdown
Contributor

@DianaHackmamba DianaHackmamba Mar 31, 2026

Choose a reason for hiding this comment

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

Same as above. Matching should include matching case.

docs/relnotes/support-matrix.mdx Outdated
:::

| **Functional Area** | **Component** | **Version** | **Notes** |
| **Functional area** | **Component** | **Version** | **Notes** |
Copy link
Copy Markdown
Contributor

@DianaHackmamba DianaHackmamba Mar 31, 2026

Choose a reason for hiding this comment

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

Why are these bold? Styling of column headers should be managed in the CSS, not local formatting.

Copy link
Copy Markdown
Contributor Author

@gyrationtechs gyrationtechs Apr 1, 2026

Choose a reason for hiding this comment

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

Good catch. Updated.

nstanford5
nstanford5 previously approved these changes Mar 31, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@nstanford5 nstanford5 left a comment

Choose a reason for hiding this comment

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

Approving as confirmation of the requested structure. Thanks @gyrationtechs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nstanford5 nstanford5 nstanford5 left review comments

@DianaHackmamba DianaHackmamba Awaiting requested review from DianaHackmamba

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gyrationtechs @nstanford5 @DianaHackmamba