docs: rotate documentation for 2624 distribution#3320
Draft
jpraynaud wants to merge 1 commit into
Draft
Conversation
There was a problem hiding this comment.
Pull request overview
This PR rotates the version-maintained documentation to align with the new 2624 distribution, updating network/runtime details (Cardano/DMQ), refining certification docs, and refreshing the published OpenAPI spec.
Changes:
- Update maintained docs to reflect DMQ “beta” rollout and Cardano node
11.0.xcompatibility across guides/matrix. - Consolidate Cardano DB certification documentation (remove the separate “v2” page) and adjust sidebar ordering accordingly.
- Refresh the published OpenAPI spec (
openapi.current.yaml) to match the current aggregator API surface and schemas.
Reviewed changes
Copilot reviewed 16 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/website/versioned_sidebars/version-maintained-sidebars.json | Sidebar formatting/ordering adjustments for maintained docs navigation. |
| docs/website/versioned_docs/version-maintained/use-cases/bridges.mdx | Updates bridge flow wording (contains a typo to fix). |
| docs/website/versioned_docs/version-maintained/networks-matrix.md | Refreshes network compatibility/status matrix (adds DMQ details, bumps Cardano versions). |
| docs/website/versioned_docs/version-maintained/mithril/advanced/threat-model.md | Updates KES documentation links to IntersectMBO repo. |
| docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-certification/cardano-node-database.md | Reworks Cardano DB certification narrative to the incremental/Merkle approach and updates diagrams/verification steps. |
| docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-certification/cardano-node-database-v2.md | Removes the separate “v2” page after consolidating content elsewhere. |
| docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-certification/cardano-blocks-and-transactions.md | Adjusts sidebar position after certification doc reorganization. |
| docs/website/versioned_docs/version-maintained/manual/operate/run-signer-node.md | Updates DMQ setup guidance (beta), DMQ version, and adds Shelley genesis config parameter + CIP-155 section. |
| docs/website/versioned_docs/version-maintained/manual/operate/run-aggregator-node.md | Updates SIGNED_ENTITY_TYPES example and DMQ setup guidance (beta), version, and adds Shelley genesis config parameter. |
| docs/website/versioned_docs/version-maintained/manual/getting-started/bootstrap-cardano-node.md | Bumps Cardano node version in examples/output snippets to 11.0.1. |
| docs/website/versioned_docs/version-maintained/manual/develop/run-mithril-devnet.md | Removes the “run a private network” devnet guide from maintained docs. |
| docs/website/versioned_docs/version-maintained/manual/develop/references.md | Updates devnet reference entry (contains a broken GitHub link to fix). |
| docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-client.md | Updates utxo-hd snapshot-converter parameters (adds --binary-path, --config-path, adds LSM). |
| docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-aggregator.md | Updates signed entity types example and documents mithril_era param for genesis-related commands. |
| docs/website/versioned_docs/version-maintained/case-studies/daedalus.mdx | Adjusts Daedalus sync-time wording. |
| docs/website/openapi.current.yaml | Updates OpenAPI version and removes legacy snapshot endpoints/schemas; updates signed entity types; adds SNARK-friendly certificate fields. |
Test Results 5 files ± 0 206 suites ±0 1h 2m 57s ⏱️ - 4h 50m 44s Results for commit 8fef07a. ± Comparison against base commit 7d13b76. This pull request removes 69 tests.♻️ This comment has been updated with latest results. |
3eae1b6 to
cd28d19
Compare
With release of distribution '2624' by running 'make update-current' command.
cd28d19 to
8fef07a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Content
This PR includes the rotation of the documentation with the release of the new
2624distribution.Pre-submit checklist
Issue(s)
Relates to #3271