Commit 74401d2
authored
fix(docs): fable review (#24005)
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.1` tag, source facts against
`next`).
## Tutorials
- **Counter tutorial** (source + v4.3.1): adds the missing "clear the
scaffold's placeholder test" note. As written, renaming the contract
`Main` -> `Counter` leaves the generated `counter_test` crate
referencing `Main`, so `aztec compile` fails with 6 errors (reproduced
on a live local network). The token and recursive-verification tutorials
already carry this note.
- **Token bridge tutorial** (source + v4.3.1): the deploy script was
inlined from the monorepo's CI example, and its artifact imports don't
resolve in the Hardhat project the tutorial sets up. Adds a correction
note (Hardhat artifact paths and `bytecode` vs Forge's
`bytecode.object`), fixes the run command (`npx tsx scripts/index.ts`
instead of `npx 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-contracts` tag (pinned to v4.2.0-aztecnr-rc.2;
a `v4.3.1` tag exists upstream), and fixes a broken relative link.
## CLI references
- **aztec CLI reference** (source + v4.3.1): the `aztec start` section
was completely empty. Adds usage, examples, common options, and module
flags (verified against `aztec_start_options.ts`), linking to the
operator CLI reference for the full per-module list.
- **aztec-wallet CLI reference** (source + v4.3.1): removes
generator-machine leakage: `--data-dir` default
`/home/josh/.aztec/wallet` -> `~/.aztec/wallet`, `--node-url` default
`host.docker.internal` -> `localhost`.
## Operator docs
- **useful-commands / governance-participation** (source + v4.3.1): the
documented cast calls target functions that no longer exist on the
governance contracts. `M()` -> `ROUND_SIZE()`, `N()` -> `QUORUM_SIZE()`,
`yeaCount(...)` -> `signalCount(...)` (EmpireBase.sol), and
`proposals(uint256)` (internal mapping) -> `getProposal(uint256)`
(Governance.sol).
- **slashing-configuration** (source + v4.3.1): the ejection description
("98% of activation, max 3 slashes") didn't match the implementation.
Slashing ejection is driven by the rollup's `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
- **events_and_logs** (source + v4.3.1):
`self.context.emit_public_log(...)` doesn't exist; corrected to
`emit_public_log_unsafe(tag, log)` with a pointer to prefer
`self.emit(event)`.
- **state_variables / how_to_retrieve_filter_notes** (source + v4.3.1):
`get_notes`/`remove` documented around nonexistent
`RetrievedNote`/`HintedNote` types; the actual return type is
`ConfirmedNote`.
- **contract_structure** (source + v4.3.1): claimed the storage struct
"can have any name"; the `#[storage]` macro requires it to be named
`Storage`.
- **contract_creation** (source + v4.3.1): the "Proving Contract States"
block used a nonexistent `aztec::history::contract_inclusion` module;
replaced with the real `aztec::history::deployment` assert functions.
- **outbox.md** (source only): parameter tables and `getRootData`
signature updated to the checkpoint-based `IOutbox` (`Epoch` +
`_numCheckpointsInEpoch`). The v4.3.1 copy matches its own interface and
is untouched.
Spellcheck (`yarn cspell`) passes on all 514 files.35 files changed
Lines changed: 1733 additions & 360 deletions
File tree
- docs
- developer_versioned_docs
- version-v4.3.1/docs
- aztec-nr/framework-description
- advanced
- cli
- foundational-topics
- tutorials
- contract_tutorials
- js_tutorials
- version-v5.0.0-rc.1/docs
- aztec-nr/framework-description
- advanced
- cli
- foundational-topics
- ethereum-aztec-messaging
- tutorials/js_tutorials
- docs-developers/docs
- aztec-nr/framework-description
- advanced
- cli
- foundational-topics
- ethereum-aztec-messaging
- tutorials/js_tutorials
- docs-operate/operators/sequencer-management
- network_versioned_docs
- version-v4.3.1/operators/sequencer-management
- version-v5.0.0-rc.1/operators/sequencer-management
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
37 | | - | |
| 36 | + | |
| 37 | + | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
| 101 | + | |
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
| |||
Lines changed: 5 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
89 | | - | |
| 89 | + | |
90 | 90 | | |
91 | 91 | | |
92 | | - | |
93 | | - | |
| 92 | + | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
| 96 | + | |
| 97 | + | |
96 | 98 | | |
97 | 99 | | |
98 | 100 | | |
| |||
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
579 | 579 | | |
580 | 580 | | |
581 | 581 | | |
582 | | - | |
| 582 | + | |
583 | 583 | | |
584 | 584 | | |
585 | 585 | | |
| |||
591 | 591 | | |
592 | 592 | | |
593 | 593 | | |
594 | | - | |
| 594 | + | |
595 | 595 | | |
596 | 596 | | |
597 | 597 | | |
| |||
602 | 602 | | |
603 | 603 | | |
604 | 604 | | |
605 | | - | |
| 605 | + | |
606 | 606 | | |
607 | 607 | | |
608 | 608 | | |
609 | | - | |
| 609 | + | |
610 | 610 | | |
611 | | - | |
| 611 | + | |
612 | 612 | | |
613 | 613 | | |
614 | 614 | | |
| |||
Lines changed: 1404 additions & 169 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
70 | | - | |
| 70 | + | |
71 | 71 | | |
72 | | - | |
| 72 | + | |
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
| |||
Lines changed: 14 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
110 | 110 | | |
111 | 111 | | |
112 | | - | |
113 | | - | |
| 112 | + | |
| 113 | + | |
114 | 114 | | |
115 | | - | |
116 | | - | |
| 115 | + | |
| 116 | + | |
117 | 117 | | |
118 | | - | |
119 | | - | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
120 | 121 | | |
121 | | - | |
122 | | - | |
| 122 | + | |
| 123 | + | |
123 | 124 | | |
124 | 125 | | |
125 | 126 | | |
| |||
docs/developer_versioned_docs/version-v4.3.1/docs/tutorials/contract_tutorials/counter_contract.md
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
68 | 77 | | |
69 | 78 | | |
70 | 79 | | |
| |||
Lines changed: 26 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
42 | 52 | | |
43 | 53 | | |
44 | 54 | | |
| |||
274 | 284 | | |
275 | 285 | | |
276 | 286 | | |
277 | | - | |
| 287 | + | |
278 | 288 | | |
279 | 289 | | |
280 | 290 | | |
| |||
667 | 677 | | |
668 | 678 | | |
669 | 679 | | |
| 680 | + | |
| 681 | + | |
| 682 | + | |
| 683 | + | |
| 684 | + | |
| 685 | + | |
| 686 | + | |
| 687 | + | |
| 688 | + | |
| 689 | + | |
| 690 | + | |
| 691 | + | |
| 692 | + | |
670 | 693 | | |
671 | 694 | | |
672 | 695 | | |
| |||
1021 | 1044 | | |
1022 | 1045 | | |
1023 | 1046 | | |
1024 | | - | |
1025 | | - | |
| 1047 | + | |
| 1048 | + | |
1026 | 1049 | | |
1027 | 1050 | | |
1028 | 1051 | | |
| |||
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
37 | | - | |
| 36 | + | |
| 37 | + | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| |||
0 commit comments