Skip to content

docs: rotate documentation for 2624 distribution#3320

Draft
jpraynaud wants to merge 1 commit into
mainfrom
jpraynaud/3271-rotate-doc-distribution-2624
Draft

docs: rotate documentation for 2624 distribution#3320
jpraynaud wants to merge 1 commit into
mainfrom
jpraynaud/3271-rotate-doc-distribution-2624

Conversation

@jpraynaud

Copy link
Copy Markdown
Member

Content

This PR includes the rotation of the documentation with the release of the new 2624 distribution.

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • All check jobs of the CI have succeeded
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update documentation website (if relevant)

Issue(s)

Relates to #3271

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.x compatibility 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.

Comment thread docs/website/versioned_docs/version-maintained/use-cases/bridges.mdx Outdated
Comment thread docs/website/versioned_docs/version-maintained/manual/develop/references.md Outdated
@github-actions

github-actions Bot commented Jun 10, 2026

Copy link
Copy Markdown

Test Results

     5 files  ± 0     206 suites  ±0   1h 2m 57s ⏱️ - 4h 50m 44s
 3 156 tests  - 69   3 156 ✅  - 69  0 💤 ±0  0 ❌ ±0 
10 628 runs   - 78  10 628 ✅  - 78  0 💤 ±0  0 ❌ ±0 

Results for commit 8fef07a. ± Comparison against base commit 7d13b76.

This pull request removes 69 tests.
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::index_out_of_bounds
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::index_too_large_for_circuit_range
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::indices_not_increasing
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_merkle_path_mismatch
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_swap_keep_merkle_path
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::leaf_wrong_verification_key
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_corrupt_sibling
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_flip_position
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_length_long
mithril-stm ‑ circuits::halo2::tests::golden::cases::negative::slow::merkle_path_length_short
…

♻️ This comment has been updated with latest results.

@jpraynaud jpraynaud force-pushed the jpraynaud/3271-rotate-doc-distribution-2624 branch from 3eae1b6 to cd28d19 Compare June 10, 2026 10:50
With release of distribution '2624' by running 'make update-current' command.
@jpraynaud jpraynaud force-pushed the jpraynaud/3271-rotate-doc-distribution-2624 branch from cd28d19 to 8fef07a Compare June 10, 2026 10:54
@jpraynaud jpraynaud temporarily deployed to testing-preview June 10, 2026 11:21 — with GitHub Actions Inactive

@turmelclem turmelclem left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM 👍

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants