fix(docs): fable review#24005
Draft
critesjosh wants to merge 3 commits into
Draft
Conversation
Fix critical issues found in a full docs audit, in both the source docs and the published v4.3.1 versioned docs: - counter tutorial: add the missing 'clear the scaffold placeholder test' note (renaming Main->Counter broke aztec compile with 6 errors) - token bridge tutorial: correct artifact import paths and bytecode field for the Hardhat layout, fix the run command (npx tsx), add a note to update the @aztec/l1-contracts tag, fix a broken relative link - aztec CLI reference: write the missing 'aztec start' section - aztec-wallet CLI reference: remove leaked generator-machine defaults (/home/josh/.aztec/wallet, host.docker.internal) - sequencer governance/slashing pages: replace removed contract getters (M/N/yeaCount/proposals -> ROUND_SIZE/QUORUM_SIZE/signalCount/getProposal), correct the ejection threshold description (rollup localEjectionThreshold, not '98% / max 3 slashes'), fix 36s->72s slot math - aztec-nr docs: replace nonexistent APIs (emit_public_log -> emit_public_log_unsafe, RetrievedNote/HintedNote -> ConfirmedNote, history::contract_inclusion -> history::deployment), correct the Storage struct naming claim - outbox.md (source only): update IOutbox signatures to the checkpoint-based interface
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.
Fixes the critical issues found in a full audit of the docs site, applied to both the source docs and the published v4.3.1 versioned docs (versioned facts verified against the
v4.3.1tag, source facts againstnext).Tutorials
Main->Counterleaves the generatedcounter_testcrate referencingMain, soaztec compilefails with 6 errors (reproduced on a live local network). The token and recursive-verification tutorials already carry this note.bytecodevs Forge'sbytecode.object), fixes the run command (npx tsx scripts/index.tsinstead ofnpx hardhat run ... --network localhost, which targets a network the starter repo doesn't define), adds a note to update the starter repo's@aztec/l1-contractstag (pinned to v4.2.0-aztecnr-rc.2; av4.3.1tag exists upstream), and fixes a broken relative link.CLI references
aztec startsection was completely empty. Adds usage, examples, common options, and module flags (verified againstaztec_start_options.ts), linking to the operator CLI reference for the full per-module list.--data-dirdefault/home/josh/.aztec/wallet->~/.aztec/wallet,--node-urldefaulthost.docker.internal->localhost.Operator docs
M()->ROUND_SIZE(),N()->QUORUM_SIZE(),yeaCount(...)->signalCount(...)(EmpireBase.sol), andproposals(uint256)(internal mapping) ->getProposal(uint256)(Governance.sol).localEjectionThreshold(190,000 on mainnet, 95% of the 200,000 activation threshold; StakingLib withdraws the entire remaining stake when a slash would cross it). Also fixes stale 36s-per-slot math (slots are 72s) and the "28 rounds on testnet" execution-delay label (28 rounds is mainnet). Source and v4.3.1 copies use their respective slash amounts (v4.3.1: all 2,000; next: 2,000/5,000 per AZIP-16).Aztec.nr / foundational topics
self.context.emit_public_log(...)doesn't exist; corrected toemit_public_log_unsafe(tag, log)with a pointer to preferself.emit(event).get_notes/removedocumented around nonexistentRetrievedNote/HintedNotetypes; the actual return type isConfirmedNote.#[storage]macro requires it to be namedStorage.aztec::history::contract_inclusionmodule; replaced with the realaztec::history::deploymentassert functions.getRootDatasignature updated to the checkpoint-basedIOutbox(Epoch+_numCheckpointsInEpoch). The v4.3.1 copy matches its own interface and is untouched.Spellcheck (
yarn cspell) passes on all 514 files.