Skip to content

docs: release skills re-verify every networks.md figure against sources of truth - #24770

Merged
alejoamiras merged 1 commit into
nextfrom
cb/release-docs-verification
Jul 17, 2026
Merged

docs: release skills re-verify every networks.md figure against sources of truth#24770
alejoamiras merged 1 commit into
nextfrom
cb/release-docs-verification

Conversation

@AztecBot

Copy link
Copy Markdown
Collaborator

Generalizes the verification lessons from the v5.0.1 docs release (#24763) — specifically from cross-checking the machine-derived networks.md values against the hand-written ones in #24756 — into the /release-docs and /release-network-docs skills, so every future release re-checks all of it against sources of truth instead of trusting carried-forward or hand-transcribed values.

The two discrepancies that cross-check caught, which motivate the rules:

  • The mainnet rollup version was hand-converted from 0xfd39c8f7 and shipped wrong (4248094967 instead of 4248422647).
  • The Alpha Execution Delay was carried forward as 30 days when the live Governance.getConfiguration() says 2 days — the governance table had no re-verification step at all.

What the skills now require, every release

A new "Re-verify every figure against its source of truth" subsection in /release-docs Step 9 (referenced from /release-network-docs Step 4), plus a Key Point:

  • EIP-55 checksums: every L1 address goes through cast to-check-sum-address before landing in the tables.
  • Decimal conversions: on-chain hex is converted with cast to-dec, never by eye.
  • Rollup version: read from each network's rollup via getVersion() and cross-checked against the RPC's rollupVersion; in the pre-release flow the target rollup's on-chain value wins.
  • L1 chain id: cast chain-id must agree with the docs row and the node RPC's l1ChainId.
  • Governance parameters table (previously never mentioned by the skills): queried on-chain for both columns — Proposer Quorum from the Governance Proposer (QUORUM_SIZE/ROUND_SIZE), Voting/Execution delays from Governance.getConfiguration() decoded against the tag's IGovernance struct (with a warning about the 256-second compressed time fields), Slashing Quorum/Round Size from the Tally Slashing Proposer (QUORUM, ROUND_SIZE, ROUND_SIZE_IN_EPOCHS).
  • Cross-check human-owned data: when the network team has a parallel deployment update in flight, diff every value against it and resolve discrepancies by querying the chain, then reconcile with the owner before shipping.

Stacked on #24763 (which already added the cast to-dec note and the migration-notes TBD rule); once that merges this PR retargets to next and carries only these two skill files.


Created by claudebox · group: slackbot · Slack thread

@AztecBot AztecBot added ci-draft Run CI on draft PRs. ci-no-fail-fast Sets NO_FAIL_FAST in the CI so the run is not aborted on the first failure claudebox Owned by claudebox. it can push to this PR. labels Jul 17, 2026
@AztecBot
AztecBot force-pushed the cb/docs-release-v5.0.1 branch from b8d15fe to 6b6eb1f Compare July 17, 2026 15:07
Base automatically changed from cb/docs-release-v5.0.1 to next July 17, 2026 15:53
@AztecBot
AztecBot force-pushed the cb/release-docs-verification branch from 64b26eb to 084c41d Compare July 17, 2026 17:54
@alejoamiras
alejoamiras marked this pull request as ready for review July 17, 2026 19:48
@alejoamiras
alejoamiras enabled auto-merge July 17, 2026 19:48
@alejoamiras
alejoamiras added this pull request to the merge queue Jul 17, 2026
Merged via the queue into next with commit 60ba528 Jul 17, 2026
31 of 35 checks passed
@alejoamiras
alejoamiras deleted the cb/release-docs-verification branch July 17, 2026 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-draft Run CI on draft PRs. ci-no-fail-fast Sets NO_FAIL_FAST in the CI so the run is not aborted on the first failure claudebox Owned by claudebox. it can push to this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants