docs: fix aztec-nr v4.2.0 documentation issues from audit#22166
Merged
docs: fix aztec-nr v4.2.0 documentation issues from audit#22166
Conversation
sklppy88
approved these changes
Apr 1, 2026
AztecBot
force-pushed
the
docs/aztec-nr-v4.2.0-doc-audit-fixes
branch
from
7f1bd43 to
2626b7c
Compare
## Summary - Fix 52 issues across all aztec-nr doc pages identified during a manual review against `nargo 1.0.0-beta.18` and local Aztec network `v4.2.0-aztecnr-rc.2` - Fixes applied to both `docs-developers/` (source) and `developer_versioned_docs/version-v4.2.0-aztecnr-rc.2/` (versioned copy) - Key categories: deprecated import paths, missing API parameters (capsule `scope`), non-existent methods (`simulate_utility`, `msg_sender().unwrap()`), incorrect struct names, out-of-bounds array access in code examples, wrong dependency URLs, stale content removal ### Critical fixes (would cause compilation failures if copied from docs) - Add missing `scope` parameter to all capsule API examples - Fix `CapsuleArray::at()` call signature (2 args → 3) - Fix out-of-bounds array access in `sort_efficient` example - Update `debug_log` import path (`dep::aztec::oracle::debug_log` → `aztec::oracle::logging`) - Replace `simulate_utility()` with `execute_utility()` - Fix `NoteMessagePendingDelivery` → `NoteMessage` - Correct partial note commitment structure (`storage_slot` in completion phase, not partial phase) ### Other fixes - Update all `dep::` import prefixes to current unprefixed style - Fix dependency URLs from `aztec-packages` repo to `aztec-nr` repo - Correct `ONCHAIN_CONSTRAINED` link that pointed to `ONCHAIN_UNCONSTRAINED` - Remove stale TODO comments, placeholder image, delegate_call references - Update pedersen → poseidon2, `return_values: BoundedVec` → `return_hash: Field` - Fix variable name mismatch (`TWO_POW_32` → `TWO_POW_16`) - Add missing `unconstrained` keyword to utility function examples - Add missing `#[derive]` attributes on `NFTNote` in AIP-721 ## Test plan - [ ] Verify docs build succeeds (`yarn build` in docs/) - [ ] Spot-check code examples against source at `v4.2.0-aztecnr-rc.2` tag - [ ] Review rendered pages for formatting issues
AztecBot
force-pushed
the
docs/aztec-nr-v4.2.0-doc-audit-fixes
branch
from
2626b7c to
06a09f0
Compare
Collaborator
|
❌ Failed to cherry-pick to |
critesjosh
added a commit
that referenced
this pull request
Apr 1, 2026
…22166) (#22227) ## Summary Backport of #22166 to v4-next. Fixes 52 documentation issues across aztec-nr doc pages (deprecated import paths, missing API parameters, incorrect method names, wrong dependency URLs, etc.). ## Conflict resolution All 20 conflicts were modify/delete in `docs/developer_versioned_docs/version-v4.2.0-aztecnr-rc.2/` — this versioned docs directory does not exist on v4-next, so the deletions were accepted. The 18 `docs-developers/` source files merged cleanly. ## Commits 1. Cherry-pick with conflicts (original attempt) 2. Conflict resolution (remove versioned docs that don't exist on v4-next) 3. No build fixes needed (docs-only change) ClaudeBox log: https://claudebox.work/s/78234c172376f4ce?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
3 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
nargo 1.0.0-beta.18and local Aztec networkv4.2.0-aztecnr-rc.2docs-developers/(source) anddeveloper_versioned_docs/version-v4.2.0-aztecnr-rc.2/(versioned copy)scope), non-existent methods (simulate_utility,msg_sender().unwrap()), incorrect struct names, out-of-bounds array access in code examples, wrong dependency URLs, stale content removalCritical fixes (would cause compilation failures if copied from docs)
scopeparameter to all capsule API examplesCapsuleArray::at()call signature (2 args → 3)sort_efficientexampledebug_logimport path (dep::aztec::oracle::debug_log→aztec::oracle::logging)simulate_utility()withexecute_utility()NoteMessagePendingDelivery→NoteMessagestorage_slotin completion phase, not partial phase)Other fixes
dep::import prefixes to current unprefixed styleaztec-packagesrepo toaztec-nrrepoONCHAIN_CONSTRAINEDlink that pointed toONCHAIN_UNCONSTRAINEDreturn_values: BoundedVec→return_hash: FieldTWO_POW_32→TWO_POW_16)unconstrainedkeyword to utility function examples#[derive]attributes onNFTNotein AIP-721Test plan
yarn buildin docs/)v4.2.0-aztecnr-rc.2tag