Skip to content

docs(v5-next): backport doc corrections from #24005 and #23830 - #24242

Merged
critesjosh merged 1 commit into
v5-nextfrom
cb/backport-docs-v5-next
Jun 23, 2026
Merged

critesjosh merged 1 commit into
v5-nextfrom
cb/backport-docs-v5-next

Conversation

@AztecBot

Copy link
Copy Markdown
Collaborator

Backports the source-doc corrections from two already-merged next docs PRs to the v5-next release line, where the same pages were stale:

v5-next has no version-v5.0.0-rc.1 versioned snapshot (its versioned docs are v4.3.0-era), so this touches source docs only — the authored pages under docs/docs-developers/ and docs/docs-operate/.

What's included (12 files)

Each fix was re-verified against v5-next source, not blindly copied from next/v6:

From #23830

  • aztec-nr/.../advanced/how_to_prove_history.md — rewrite. Every history fn it documents (assert_note_existed_by, assert_note_was_nullified_by, assert_note_was_valid_by, assert_contract_bytecode_was_published_by, assert_contract_was_initialized_by, public_storage_historical_read) exists verbatim in v5-next's aztec/src/history/.

From #24005

  • aztec-nr/.../how_to_retrieve_filter_notes.md, state_variables.mdRetrievedNote/HintedNoteConfirmedNote (type confirmed present on v5-next).
  • aztec-nr/.../events_and_logs.md — nonexistent self.context.emit_public_log(...)emit_public_log_unsafe (confirmed at public_context.nr:110 on v5-next).
  • aztec-nr/.../contract_structure.md — storage struct must be named Storage (version-agnostic).
  • foundational-topics/contract_creation.mdaztec::history::contract_inclusionaztec::history::deployment (the deployment module exists on v5-next).
  • foundational-topics/.../outbox.md — checkpoint-based IOutbox (getRootData(Epoch, uint256) confirmed in v5-next's IOutbox.sol).
  • cli/aztec_cli_reference.md — fills the empty aztec start section; all documented module flags (--network, --node, --sequencer, --prover-node, --prover-broker, --prover-agent, --p2p-bootstrap, --txe, --bot, --admin-port) exist in v5-next's aztec_start_options.ts.
  • cli/aztec_wallet_cli_reference.md — removes generator-machine leakage in default values (/home/josh/.aztec/wallet~/.aztec/wallet, host.docker.internallocalhost).
  • operators/.../governance-participation.md, useful-commands.md — stale governance calls fixed: M()ROUND_SIZE(), N()QUORUM_SIZE(), yeaCount(...)signalCount(...), proposals(uint256)getProposal(uint256). Confirmed: v5-next Governance.sol exposes getProposal, EmpireBase.sol exposes ROUND_SIZE/QUORUM_SIZE/signalCount; old names are gone.
  • tutorials/js_tutorials/token_bridge.md — Hardhat artifact-path / run-command corrections; the @aztec/l1-contracts version note uses the #include_aztec_version macro, so it resolves to the v5 version automatically.

Deliberately excluded — needs a v5-specific numeric pass

  • slashing-configuration.mdfix(docs): fable review #24005's numbers are next/mainnet-framed and do not match the live v5 testnet. The v5 upgrade deploy (DeployRollupForUpgradeV5.s.sol, Sepolia branch) sets localEjectionThreshold = 199,000e18 and slash amounts 100k / 250k / 250k (AZIP-16 full-stake), versus the doc's 190k + 2,000/5,000. Slot duration (72s) and round size (128 slots) do check out for v5 (confirmed via live testnet block spacing of 72s). This page should be rewritten with verified v5-testnet values in a follow-up rather than copied.

Source PRs: #24005, #23830. No tracked issue is closed by this backport.


Created by claudebox · group: slackbot

@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. documentation labels Jun 23, 2026
@critesjosh
critesjosh marked this pull request as ready for review June 23, 2026 16:06
@critesjosh
critesjosh enabled auto-merge June 23, 2026 16:06
@critesjosh
critesjosh added this pull request to the merge queue Jun 23, 2026
Merged via the queue into v5-next with commit 68466fa Jun 23, 2026
48 of 56 checks passed
@critesjosh
critesjosh deleted the cb/backport-docs-v5-next branch June 23, 2026 16:57
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. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants