chore(docs): cut versioned developer docs for v4.2.0 (mainnet)#22581
Merged
critesjosh merged 11 commits intonextfrom Apr 16, 2026
Merged
chore(docs): cut versioned developer docs for v4.2.0 (mainnet)#22581critesjosh merged 11 commits intonextfrom
critesjosh merged 11 commits intonextfrom
Conversation
AztecBot
added
ci-draft
- Built docs with MAINNET_TAG=4.2.0 RELEASE_TYPE=mainnet COMMIT_TAG=v4.2.0 so all version macros resolve correctly (no @latest, source URLs point to v4.2.0) - Generated CLI reference docs from aztec CLI v4.2.0 - Cut versioned developer docs snapshot for v4.2.0 - Removed old v4.2.0-aztecnr-rc.2 pre-release versioned docs - Removed v4.1.0-rc.2 from developer_versions.json (no longer needed) - Updated developer_version_config.json: mainnet → v4.2.0 - Updated networks.md version info to 4.2.0
AztecBot
changed the title
AztecBot
force-pushed
the
claudebox/release-docs-v4-2-0
branch
from
b60bfe4 to
0506bfd
Compare
- Aztec.nr API: 2490 HTML files in static/aztec-nr-api/mainnet/ Generated with nargo doc from noir-projects/aztec-nr at v4.2.0 tag - TypeScript API: 9 markdown files in static/typescript-api/mainnet/ Generated with TypeDoc from yarn-project packages at v4.2.0 tag Covers: aztec.js, accounts, pxe, wallet-sdk, wallets, entrypoints, stdlib, foundation, constants
…sites Expands the Prerequisites section in Step 6 (Generate API Reference Docs) to explicitly list all required build steps: submodule init, noir bootstrap, yarn-project build, and aztec CLI install.
…node API reference - Added node JSON-RPC API reference generator from PR #22543 (scripts/node_api_reference_generation/) - Generated node API reference for v4.2.0 (64 methods: 56 node + 8 admin) - Cut network versioned docs snapshot for v4.2.0 - Updated network_version_config.json: mainnet → v4.2.0, testnet stays v4.1.3 - network_versions.json: ["v4.2.0", "v4.1.3"]
Removes old v4.1.3 network versioned docs directory, sidebar, and config/versions references. Only v4.2.0 remains.
…stnet, private and third-party FPC guides Expand fee documentation to reflect that the Sponsored FPC is now available on testnet (not just devnet/local). Add a new guide for private fee payment via Wonderland's PrivateFPC, a third-party FPC section with Nethermind's Private Multi Asset FPC example, and a conceptual "How FPCs work" section. Includes two new migration notes (nullifier witness split types, empire slasher removal) and cross-file link fixes.
- Updated migration notes for version 4.2.0, including breaking changes and migration steps for various components. - Added high availability setup instructions to the sequencer setup documentation. - Clarified slashing configuration and reward claiming processes in operator guides. - Improved blob storage retrieval process documentation. - Removed deprecated fields and updated examples in aztec.js documentation. - Enhanced clarity on the Tally Model of slashing and its implications for sequencer operators.
…e workflows and contract address resolution
…TypeScript API files to 4.2.0
…d nodeAdmin_getSlashPayloads reference
critesjosh
approved these changes
Apr 16, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
3 tasks
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Apr 17, 2026
…22609) ## Summary Fixes a regression from PR #22581 where the operator changelog `reference/changelog/v4.md` in the v4.2.0 versioned docs had old stub content (93 lines) instead of the full expanded changelog (333 lines). **Root cause:** The v4.1.3 versioned copy of `reference/changelog/v4.md` was independently updated (commit d44c526) with comprehensive entries for all v4.x breaking changes and new features, but those changes were never propagated back to the source `docs-operate/`. When v4.2.0 docs were cut from source, they inherited the old stub. **Changes:** - Restored full v4.md changelog content (Node.js upgrade, bot fee padding, L2Tips restructure, block gas limits, setup allowlist, sequencer renames, HA slashing, blob publication, withdrawal delay, prover changes, admin API key, tx pool error codes, etc.) - Added v4.2.md to the sidebar and changelog index so it's discoverable - Fixed broken link: `high_availability_sequencers` → `high-availability` - Updated both versioned docs (v4.2.0) and source docs-operate ## Test plan - [ ] Verify `docs/network_versioned_docs/version-v4.2.0/reference/changelog/v4.md` matches `operators/reference/changelog/v4.md` - [ ] Verify v4.2.md appears in the sidebar - [ ] Run `yarn build` in docs/ to confirm no broken links ClaudeBox log: https://claudebox.work/s/62e0b9bc1a1fea36?run=2
AztecBot
added a commit
that referenced
this pull request
Apr 17, 2026
Adapt cherry-pick result for v4-next, which does not yet contain the v4.2.0 versioned snapshot nor the operator v4.2.md source file. - Revert misdirected rename targets in v4.1.2/operators/changelog/index.md and v2.1.11-ignition-sidebars.json (v4.2 entries point to files that do not exist on this branch). - Drop the v4.2 entries from docs-operate/operators/reference/changelog/ index.md and sidebars-operate.js for the same reason — including them would break the Docusaurus build. They should be added back when v4.2 infrastructure (#22581 / #22612) is backported. Kept: - docs-operate/reference/changelog/v4.md content restore (core fix) - v4.1.2/operators/reference/changelog/v4.md HA-guide link fix (the target file is high-availability.md on v4-next too, so the underscore link was already broken here).
3 tasks
critesjosh
added a commit
that referenced
this pull request
Apr 17, 2026
## Summary Backport of #22609 onto `v4-next`. The upstream PR did two things: 1. **Core fix**: restore the full v4.x changelog content (325 lines) in the docs-operate source. The stub had regressed via PR #22581. 2. **v4.2 discoverability**: advertise `v4.2.md` by adding it to the operator changelog index, the `sidebars-operate.js` sidebar, and the `version-v4.2.0/` versioned snapshot. Only (1) applies to `v4-next`. The v4.2.0 versioned folder and `v4.2.md` source file do not exist on this branch yet (PRs #22581 / #22612 have not been backported), so advertising `v4.2.md` would break the Docusaurus build. ## 3-commit structure Per `.claude/claudebox/backport.md`: 1. `cherry-pick: ... (with conflicts)` — raw `git cherry-pick -m 1 -Xno-renames cbb09bc` output. Git's rename detection misrouted the v4.2.0 patches onto `version-v2.1.11-ignition` and `version-v4.1.2`, producing a conflict plus unwanted auto-merges. 2. `fix: resolve cherry-pick conflicts` — restore `version-v2.1.11-ignition/reference/changelog/v4.md` to its pre-cherry-pick state. The conflict was caused by the misdirected rename, not by real content that belongs here. 3. `fix: adapt backport for v4-next (no v4.2.0 version yet)` — revert the remaining rename-misfires, and drop the v4.2 entries from `docs-operate` index.md + `sidebars-operate.js` that would reference the non-existent `v4.2.md`. Keep the HA-guide link fix (`high_availability_sequencers` → `high-availability.md`), which is valid on v4-next too. ## Net effect ``` docs/docs-operate/reference/changelog/v4.md | 324 ++++++++++++++++++--- .../operators/reference/changelog/v4.md | 2 +- ``` Analysis: https://gist.github.com/AztecBot/8024d49bed623cf741c9fd64f72505b0 ## Test plan - [ ] `yarn build` in `docs/` succeeds (no broken sidebar / broken-link errors). - [ ] `docs/docs-operate/reference/changelog/v4.md` renders with the full v4.x migration content. - [ ] Revisit `docs-operate/operators/reference/changelog/index.md` + `sidebars-operate.js` after #22581 / #22612 are backported to re-add v4.2 entries. ClaudeBox log: https://claudebox.work/s/c59bb40b529f1bc2?run=1
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
2 participants
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.
Summary
MAINNET_TAG=4.2.0 RELEASE_TYPE=mainnet COMMIT_TAG=v4.2.0so all version macros resolve correctly (no@latest, source URLs point tov4.2.0)aztec_cli_reference.md,aztec_up_cli_reference.md,aztec_wallet_cli_reference.md)v4.2.0-aztecnr-rc.2pre-release versioned docsv4.1.0-rc.2fromdeveloper_versions.jsondeveloper_version_config.json: mainnet →v4.2.0networks.mdversion info to4.2.0Files changed
docs/developer_version_config.json— mainnet points tov4.2.0docs/developer_versions.json— onlyv4.2.0(removedv4.2.0-aztecnr-rc.2andv4.1.0-rc.2)docs/developer_versioned_docs/version-v4.2.0/— new versioned snapshot with correct version tagsdocs/developer_versioned_docs/version-v4.2.0-aztecnr-rc.2/— deleteddocs/developer_versioned_sidebars/— renamed sidebar filedocs/docs-developers/docs/cli/— regenerated CLI reference docsdocs/docs/networks.md— updated version to4.2.0