docs: update Aggregation Mode and deprecate Verification Layer - #2306
Conversation
Codex Code Review
No security vulnerabilities or significant performance issues found in this documentation-only diff. |
90e2f0d to
60f75c3
Compare
ReviewThis is a docs-only PR (no application/contract code changes), so the security/perf/logic-bug categories mostly don't apply. I focused on factual accuracy and link integrity instead. Verified and looks solid:
No bugs or inaccuracies found. The archive-vs-delete approach, deprecation banners, and SUMMARY.md pruning are all consistent and correctly cross-linked. Nice thorough verification pass in the PR description itself (link checker, flag-by-flag No inline comments needed — nothing rose to the level of a real defect. |
b36358a to
7404f7a
Compare
The Aligned Verification Layer is deprecated and Aggregation Mode is the
only active system in this repo, but the docs still presented both as live
products and in places recommended the Verification Layer first.
Archive, don't delete: Verification Layer pages and the operator guides move
to docs/archive/, which mirrors the original directory depth so their relative
image links keep resolving. Nothing under docs/archive/ is listed in
SUMMARY.md, so GitBook no longer shows it while it stays reachable.
Aggregation Mode docs:
- Drop the "available on the staging branch" notes and `git checkout staging`;
it is merged on testnet, which is the default branch.
- Fix the CLI binary name (`agg_mode_cli`, not `agg-mode-cli`) and replace the
`--version` check with `--help`; the CLI declares no version flag.
- Document the fixed 0.0035 ether deposit, that `--public-inputs` is required
in practice, and that `--proving-system Risc0` is parsed but not functional.
- Add an install and Hello World section to the SDK reference, and the missing
Risc0 variant of AggregationModeVerificationData.
- Stop routing the L2 example's step 1 through the Verification Layer and drop
`make batcher_start_ethereum_package` from its localnet setup.
Rewrites: the quickstart (was Try Aligned) walks the agg mode CLI, generating
proofs covers SP1 compressed proofs, key terms and supported verifiers describe
the aggregation pipeline, and a new Explorer page documents the aggregated
proof views.
Restructure, now that the Verification Layer is gone: Introduction keeps only
about / use cases / FAQ / why ZK, everything else folds into a single Proof
Aggregation Layer section split into Architecture and Guides, and RaaS gets its
own section. Files move to docs/2_proof_aggregation_layer/{architecture,guides}/
with sequential names, dropping the numbering gaps the archived pages left
behind. This changes published URLs for the aggregation mode pages.
Navigation links: the explorers become an Explorers group inside Proof
Aggregation Layer, the website link moves to Introduction, and the
Socials group is gone -- it read as a product section in the sidebar, and
GitBook has a real footer for social accounts (site settings, not this repo).
The two blog links that were in Useful links move into page content so they
are not lost: the manifesto onto About Aligned, the aggregation post onto Use
cases.
Also repoints the circom, validating-public-input and zkquiz READMEs at the
archived local setup guide; they were the only links into docs/ from outside
it, and the archive move had broken all three.
.gitbook.yaml gains 38 redirects so existing docs.alignedlayer.com links keep
working: moved pages go to their new home, and the removed Verification Layer
pages land on the closest Proof Aggregation Layer page instead of 404ing.
GitBook only publishes what SUMMARY.md lists, so archived files cannot be
redirect targets.
Also fixed along the way:
- Hoodi AlignedProofAggregationService was listed twice with different
addresses; kept the one in sdk/src/constants.rs and the deployment output.
- Noted that the CLI and SDK do not support Sepolia.
- Restored the RaaS Figure 1 image, repointed to the wrong file in #2111, and
fixed Figure 2 to the renamed zk_rollups_and_aligned.png.
- Corrected the ansible runbook's claim that mainnet tracks `main`; both
environments set git_branch=staging.
Closes #2305
7404f7a to
84a2e7b
Compare
Applies to the two places that name the product as a title: the sidebar group in SUMMARY.md and the page's own heading. Changing only the first would have left the sidebar and the page title disagreeing. Two other occurrences are left alone deliberately. In 1_introduction/ 2_faq.md the hyphens are doing grammatical work -- "a Rollup-as-a-Service platform" is a compound adjective there, alongside "Wallet-as-a-Service infrastructure" in the same sentence. In 1_introduction/0_about_aligned.md it appears in a product list, which is a naming call rather than a typo.
|
/claude /codex |
Codex Code ReviewNo actionable issues found in the PR diff. The changes are documentation-only; no security vulnerabilities or significant performance issues were identified. |
Closes #2305
Why
The Aligned Verification Layer is deprecated and Aggregation Mode is the only active system in this repo, but the docs still presented both as live products — and in places recommended starting with the Verification Layer. The Aggregation Mode pages were also stale: two of them still told users it lived on the
stagingbranch.Approach: archive, don't delete
Verification Layer pages move to
docs/archive/rather than being removed. The archive mirrors the original directory depth, so the relative image links inside moved pages keep resolving with no edits. Archived pages are not listed inSUMMARY.md, so GitBook stops showing them in the nav while they stay reachable by URL.Operator guides stay where they are, with a deprecation banner, and are dropped from
SUMMARY.mdso they no longer appear in the GitBook.Surviving guide filenames are not renumbered — GitBook orders the nav from
SUMMARY.md, and renaming would break publisheddocs.alignedlayer.comURLs.Aggregation Mode fixes
Beyond removing the
stagingbranch instructions, these were verified against a release build ofagg_mode_cli:agg_mode_cli --versiondoes not exist. The CLI declares no version flag, so the documented install check errored. Replaced with--help.agg-mode-clivs the realagg_mode_cli.depositsends a fixed 0.0035 ether, not an arbitrary amount. This was undocumented.--public-inputswas documented as optional butverify-on-chainexits withPublic input file not providedwithout it.--proving-system Risc0is accepted by the parser but the check is always performed as SP1. Documented as non-functional rather than dropped, since--helpstill advertises it.Risc0variant ofAggregationModeVerificationData. No released tag containsagg_mode_sdk(atv0.20.0theaggregation_mode/tree has nosdk/crate), so the dependency pinsbranch = "testnet"— confirmed to resolve.make batcher_start_ethereum_packageis gone from its localnet setup. The example code already depended only onagg_mode_sdk; only the prose was stale. Same fixes applied toexamples/l2/README.md.Rewrites
scripts/test_files/sp1/.fibonacci_proof_generator.Unrelated bugs fixed along the way
AlignedProofAggregationServicewas listed twice with different addresses. Kept the one matchingaggregation_mode/sdk/src/constants.rsand the deployment output (0x6B34AAaE…)."0x0"address, empty gateway URL).main, but both ini configs setgit_branch=staging— andmaindoes not exist on the remote.Verification
docs/: 41 broken → 3, the 3 remaining being pre-existing breaks indocs/0_internal/(left alone, unpublished internal runbooks).batcher,Proof Verification Layer,aligned submit,agg-mode-cliorcheckout stagingleft in published docs.maketarget and file path referenced by published docs confirmed to exist.--helpon a real release build.Follow-ups (code, not docs)
verify-on-chainignores--proving-systemand always buildsAggregationModeVerificationData::SP1.deposit's clap help string says "Send 1 ether" but it sends 0.0035.🤖 Generated with Claude Code