Repository navigation
Conversation
jpraynaud
requested review from
Alenar,
damrobi and
turmelclem
as code owners
October 14, 2026 16:05
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Documentation inaccuracies and invalid or incomplete examples remain unresolved.
3 open findings
What changed in this PR
This PR rotates the maintained documentation for the 2642 distribution.
Changes:
- Documents protocol configuration and SNARK aggregation.
- Updates operator, signer, client, and aggregator guides.
- Refreshes network metadata, glossary, navigation, and OpenAPI documentation.
| File | Summary |
|---|---|
docs/website/versioned_sidebars/version-maintained-sidebars.json |
Reformats sidebar entries. |
docs/website/versioned_docs/version-maintained/networks-matrix.md |
Updates network configuration details; retain the newer update date. |
docs/website/versioned_docs/version-maintained/mithril/advanced/threat-model.md |
Documents protocol configuration security. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/security.md |
Adjusts sidebar ordering. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/README.mdx |
Describes aggregation flavors. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/protocol.md |
Updates protocol setup; make circuit-key requirements SNARK-specific. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/certificates.md |
Documents certificate chains and caching. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/aggregation/recursive-snark.md |
Adds recursive SNARK documentation. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/aggregation/README.mdx |
Adds aggregation overview. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/aggregation/non-recursive-snark.md |
Adds non-recursive SNARK documentation; correct Merkle leaf contents. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/aggregation/concatenation.md |
Adds concatenation documentation. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-protocol/aggregation/_category_.json |
Adds aggregation navigation metadata. |
docs/website/versioned_docs/version-maintained/mithril/advanced/mithril-network/signer.md |
Clarifies protocol parameter retrieval for newer signers. |
docs/website/versioned_docs/version-maintained/manual/operate/run-signer-node.md |
Documents protocol configuration setup; corrects version wording. |
docs/website/versioned_docs/version-maintained/manual/operate/run-aggregator-node.md |
Updates aggregator configuration; fix unavailable production configuration files. |
docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-client.md |
Documents client cache options. |
docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-client-library.md |
Documents library caching; use the non-deprecated builder API. |
docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-client-library-wasm.md |
Documents WASM caching; initialize the broadcast channel in the example. |
docs/website/versioned_docs/version-maintained/manual/develop/nodes/mithril-aggregator.md |
Updates commands and configuration; correct help, option, environment, and grammar issues. |
docs/website/versioned_docs/version-maintained/glossary.md |
Adds IVC, Merkle tree, and SNARK definitions. |
docs/website/openapi.current.yaml |
Updates API version and schemas. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
jpraynaud
marked this pull request as draft
October 14, 2026 16:17
Alenar
approved these changes
Oct 14, 2026
Generated with 'make update-current' in 'docs/website'.
The maintained matrix was last updated on 10/07/2026 with the Cardano node '11.1' support.
…y label in the networks matrix
jpraynaud
force-pushed
the
jpraynaud/3498-rotate-doc-distribution-2642
branch
from
October 15, 2026 15:24
d1afb18 to
fc7e388
Compare
This branch was successfully deployed
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
2642distribution.Pre-submit checklist
Issue(s)
Relates to #3498