fix(docs): Updating info in aztec-nr docs #19166
Open
+1,612
−2,434
Conversation
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
…, structure, upgrades, dependencies, and global variables - Updated "how to profile transactions" guide to clarify profiling steps and output analysis. - Revised "contract artifact" documentation to improve clarity on artifact structure and usage. - Enhanced "contract structure" section with clearer explanations and next steps for developers. - Streamlined "contract upgrades" documentation to emphasize upgrade processes and security considerations. - Expanded "aztec.nr dependencies" section to include detailed library paths and descriptions. - Improved "global variables" documentation to clarify differences between private and public contexts.
…tec-packages into jc/docs/aztec-nr-review
Collaborator
Flakey Tests🤖 says: This CI run detected 1 tests that failed, but were tolerated due to a .test_patterns.yml entry. |
sklppy88
approved these changes
Dec 24, 2025
|
|
||
| :::tip get_notes vs pop_notes | ||
|
|
||
| - `get_notes`: Retrieves notes without nullifying. Use when you need to read note data. |
Contributor
There was a problem hiding this comment.
Note data is not guaranteed to be current, or non-nullified
Contributor
There was a problem hiding this comment.
As an aside, I think we should move everything to include codes. Right now it's a mix of code blocks and include codes.
Comment on lines
+114
to
+117
| The message structures are: | ||
| - `L1Actor` and `L2Actor` - Represent entities on L1 and L2 respectively | ||
| - `L1ToL2Msg` - Message sent from L1 to L2 | ||
| - `L2ToL1Msg` - Message sent from L2 to L1 |
Contributor
There was a problem hiding this comment.
This section a bit verbose
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.
Summary
Comprehensive documentation review and improvements for the aztec-nr developer documentation. This PR focuses on improving clarity, structure, accuracy, and consistency across the Aztec smart contract development guides.
Changes Include:
Framework & Core Concepts
Function Documentation
How-To Guides
Advanced Topics
L1-L2 Messaging
Setup & Installation
General Improvements