Skip to content

docs(website): harmonize the DMQ beta status across the documentation - #3476

Open
jpraynaud wants to merge 9 commits into
mainfrom
jpraynaud/fix-dmq-status-pages
Open

docs(website): harmonize the DMQ beta status across the documentation#3476
jpraynaud wants to merge 9 commits into
mainfrom
jpraynaud/fix-dmq-status-pages

Conversation

@jpraynaud

@jpraynaud jpraynaud commented Aug 6, 2026

Copy link
Copy Markdown
Member

Content

This PR includes fixes for the inconsistencies about the beta status of the DMQ node across the website, and aligns the operate guides examples on the release-mainnet network:

  • Promote the DMQ status to Beta for the testing-preview network in the networks matrix
  • Replace the outdated statements announcing an unstable DMQ protocol in the run aggregator guide, and remove the reference to a removed warning in the run signer guide
  • List the networks supporting the DMQ node in both operate guides, which previously restricted it to pre-release-preview
  • Fix the DMQ bootstrap peer port and the systemd service example of the run aggregator guide
  • Align the DMQ beta wording in the dev blog posts and fix the outdated anchor of the DMQ node setup guide
  • Add the DMQ beta release update to the multiple aggregators testing program post and clarify the scope of its rollout plan
  • Switch all the examples of the operate guides to the release-mainnet parameters
  • Update the Cardano node version of the run aggregator guide to the minimum version declared in networks.json.

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

@jpraynaud jpraynaud self-assigned this Aug 6, 2026
Copilot AI lite review requested due to automatic review settings August 6, 2026 17:03

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 updates the Mithril website documentation to consistently reflect the DMQ node’s beta status and aligns the operator guides’ examples and parameters to the release-mainnet network (including updating referenced minimum Cardano node versions).

Changes:

  • Harmonize DMQ maturity wording across network matrix, operate guides, and dev blog posts (moving away from “unstable” where applicable).
  • Switch operate-guide example values/endpoints from release-preprod / preprod to release-mainnet / mainnet, and fix DMQ bootstrap/service examples.
  • Update release notes/blog program updates to reflect the DMQ beta rollout on release networks.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/website/versioned_docs/version-maintained/networks-matrix.md Marks DMQ status as Beta for testing-preview in the maintained docs.
docs/website/versioned_docs/version-maintained/manual/operate/run-signer-node.md Updates DMQ beta wording and switches examples to release-mainnet parameters (maintained docs).
docs/website/versioned_docs/version-maintained/manual/operate/run-aggregator-node.md Updates DMQ beta wording, switches examples to release-mainnet, and adjusts DMQ/systemd examples (maintained docs).
docs/website/root/networks-matrix.md Marks DMQ status as Beta for testing-preview in the root docs.
docs/website/root/manual/operate/run-signer-node.md Updates DMQ beta wording and switches examples to release-mainnet parameters (root docs).
docs/website/root/manual/operate/run-aggregator-node.md Updates DMQ beta wording, switches examples to release-mainnet, and adjusts DMQ/systemd examples (root docs).
docs/website/blog/2026-08-04-dmq-beta-release.md Aligns wording to “beta” (removes “stable (beta)”) and references updated setup anchor.
docs/website/blog/2026-08-03-distribution-2630.md Aligns distribution notes to “Promoted … to beta”.
docs/website/blog/2026-01-06-multiple-aggregators-testing-program.md Adds a 2026/08/04 update and clarifies rollout plan wording/scope.
docs/website/blog/2026-01-06-dmq-testing-program.md Updates 2026/08/04 update content and fixes the DMQ setup guide anchor reference.
Suppressed comments (2)

docs/website/root/manual/operate/run-aggregator-node.md:430

  • The /opt/mithril/mithril-aggregator.env example sets NETWORK_MAGIC even though the guide states it’s only required for non-default networks. Consider removing it from the mainnet example env file snippet to match the documented behavior.
STORE_RETENTION_LIMIT=5
NETWORK=mainnet
NETWORK_MAGIC=764824073
CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket

docs/website/versioned_docs/version-maintained/manual/operate/run-aggregator-node.md:430

  • The /opt/mithril/mithril-aggregator.env example sets NETWORK_MAGIC even though the guide states it’s only required for non-default networks. Consider removing it from the mainnet example env file snippet to match the documented behavior.
STORE_RETENTION_LIMIT=5
NETWORK=mainnet
NETWORK_MAGIC=764824073
CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket

Comment on lines 313 to 316
- **STORE_RETENTION_LIMIT**: `5`
- **NETWORK**: `preprod`
- **NETWORK_MAGIC**: `1`
- **NETWORK**: `mainnet`
- **NETWORK_MAGIC**: `764824073`
- **CARDANO_NODE_SOCKET_PATH**: `/cardano/ipc/node.socket`
Comment on lines 313 to 316
- **STORE_RETENTION_LIMIT**: `5`
- **NETWORK**: `preprod`
- **NETWORK_MAGIC**: `1`
- **NETWORK**: `mainnet`
- **NETWORK_MAGIC**: `764824073`
- **CARDANO_NODE_SOCKET_PATH**: `/cardano/ipc/node.socket`

@turmelclem turmelclem left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

Test Results

     5 files  ± 0     209 suites  ±0   57m 11s ⏱️ - 1h 39m 27s
 3 372 tests  - 76   3 372 ✅  - 76  0 💤 ±0  0 ❌ ±0 
11 226 runs   - 85  11 226 ✅  - 85  0 💤 ±0  0 ❌ ±0 

Results for commit 21d258d. ± Comparison against base commit 084c534.

This pull request removes 76 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
…

@jpraynaud
jpraynaud deployed to testing-preview August 7, 2026 07:54 — with GitHub Actions Active
@jpraynaud
jpraynaud deployed to testing-2-preview August 7, 2026 07:54 — with GitHub Actions Active
Align the `testing-preview` DMQ status with the other Mithril networks,
which all run the DMQ node version `0.7.0.0`.
The aggregator guide still announced an unstable DMQ protocol and the
signer guide referred to a warning that no longer exists.
…ides

The DMQ node is now available on the release networks and uses the same
binary version everywhere.
…guide

Use the bootstrap peer port of the networks matrix and restore the blank
line missing before the systemd install section.
Replace the ambiguous 'stable (beta)' wording with 'beta' and fix the
outdated anchor of the DMQ node setup guide.
Add the DMQ beta release update and clarify that the rollout plan is the
one of the multiple aggregators feature.
Use the `release-mainnet` parameters in all the example sets, including
the DMQ node setup which illustrated the `pre-release-preview` network.
…guide

Use the minimum version supported on mainnet declared in `networks.json`.
Replace the `Debug` trace severity with `Info` in the DMQ node configuration examples.
@jpraynaud
jpraynaud force-pushed the jpraynaud/fix-dmq-status-pages branch from 21d258d to 697f3d5 Compare August 7, 2026 09:31
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.

4 participants