Skip to content

Commit c5543cd

Browse files
New sidebar
Restructure sidebar
2 parents d1f5b36 + ae79b68 commit c5543cd

33 files changed

+430
-609
lines changed

docs/pages/aztec-nr/advanced-features/custom-notes.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This guide shows you how to create custom note types for storing specialized pri
44

55
## Prerequisites
66

7-
- Basic understanding of [Aztec private state](../../concepts/storage/state_model.md)
8-
- Familiarity with [notes and UTXOs](../../concepts/storage/index.md)
7+
- Basic understanding of Aztec private state
8+
- Familiarity with notes and UTXOs
99
- Aztec development environment set up
1010

1111
## Why create custom notes?
@@ -329,11 +329,10 @@ fn get_order(owner: AztecAddress, target_id: Field) -> OrderNote {
329329

330330
## Further reading
331331

332-
- [What the `#[note]` macro does](../../concepts/smart_contracts/functions/attributes.md#implementing-notes)
333-
- [Note lifecycle and nullifiers](../../concepts/advanced/storage/indexed_merkle_tree.mdx)
334-
- [Advanced note patterns](./advanced/how_to_retrieve_filter_notes.md)
335-
- [Note portals for L1 communication](./how_to_communicate_cross_chain.md)
336-
- [Macros reference](../../reference/smart_contract_reference/macros.md)
337-
- [Keys, including npk_m_hash](../../concepts/accounts/keys.md)
332+
- What the `#[note]` macro does - See concepts section
333+
- Note lifecycle and nullifiers - See concepts section
334+
- Advanced note patterns - See advanced features
335+
- Note portals for L1 communication - See cross-chain interactions
336+
- Macros reference - See reference section
337+
- Keys, including npk_m_hash - See concepts section
338338

339-
<!-- docs:end:how_to_implement_custom_notes -->

docs/pages/aztec-nr/compile.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,3 @@ After compilation, use the generated artifacts to:
8787
- Interact with deployed contracts using type-safe interfaces
8888
- Import contracts in other Aztec.nr projects
8989

90-
<!-- docs:end:compile_contracts -->

docs/pages/aztec-nr/debugging.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,6 @@ Check hex errors against [Errors.sol](https://github.com/AztecProtocol/aztec-pac
185185

186186
## Related Resources
187187

188-
- [Circuit Architecture](../../concepts/advanced/circuits/index.md)
189-
- [Private-Public Execution](../../concepts/smart_contracts/functions/public_private_calls.md)
190-
- [Aztec.nr Dependencies](../../reference/smart_contract_reference/dependencies.md)
188+
- Circuit Architecture - See concepts section
189+
- Private-Public Execution - See concepts section
190+
- Aztec.nr Dependencies - See reference section

docs/pages/aztec-nr/getting-started.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
## Noir VSCode Extension
44

5-
<!-- docs:start:installing_noir_lsp -->
65

76
Install the [Noir Language Support extension](https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir) to get syntax highlighting, syntax error detection and go-to definitions for your Aztec contracts.
87

@@ -16,7 +15,6 @@ which aztec-nargo
1615

1716
To specify a custom nargo executable, go to the VSCode settings and search for "noir", or click extension settings on the `noir-lang` LSP plugin. Update the `Noir: Nargo Path` field to point to your desired `aztec-nargo` executable.
1817

19-
<!-- docs:end:installing_noir_lsp -->
2018

2119
## Creating an Aztec.nr Project
2220

docs/pages/aztec-nr/installation.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Before learning how to create Aztec smart contracts, we must first install some
1515

1616
- [Docker](https://docs.docker.com/get-docker/)
1717

18-
## Install Aztec Tools
18+
## Install Aztec Tools
1919

2020
1. Docker needs to be running in order to install the sandbox.
2121

@@ -33,7 +33,6 @@ aztec --version
3333

3434
## Noir VSCode Extension
3535

36-
<!-- docs:start:installing_noir_lsp -->
3736

3837
Install the [Noir Language Support extension](https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir) to get syntax highlighting, syntax error detection and go-to definitions for your Aztec contracts.
3938

@@ -47,7 +46,6 @@ which aztec-nargo
4746

4847
To specify a custom nargo executable, go to the VSCode settings and search for "noir", or click extension settings on the `noir-lang` LSP plugin. Update the `Noir: Nargo Path` field to point to your desired `aztec-nargo` executable.
4948

50-
<!-- docs:end:installing_noir_lsp -->
5149

5250
## Creating an Aztec.nr Project
5351

docs/pages/aztec-nr/introduction-to-private-smart-contracts/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Private smart contracts on Aztec allow you to build applications where transacti
88

99
## Getting Started
1010

11-
- [A Simple Aztec Smart Contract](./simple-contract) - Start with a basic example
12-
- [Example Aztec Smart Contracts](./examples) - Explore more complex patterns
11+
- A Simple Aztec Smart Contract - Start with a basic example
12+
- Example Aztec Smart Contracts - Explore more complex patterns
1313

1414
## Key Concepts
1515

docs/pages/aztec-nr/language-description/authentication-witness.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Authentication Witness
22

3-
<!-- docs:start:use_authwit -->
43

54
Authentication witnesses (authwit) allow other contracts to execute actions on behalf of your account. This guide shows you how to implement and use authwits in your Aztec smart contracts.
65

@@ -10,7 +9,7 @@ Authentication witnesses (authwit) allow other contracts to execute actions on b
109
- Understanding of private and public functions in Aztec
1110
- Access to the `authwit` library in your contract
1211

13-
For conceptual background, see [Authentication Witnesses](../../concepts/advanced/authwit.md).
12+
For conceptual background, see Authentication Witnesses in the concepts section.
1413

1514
## Set up the authwit library
1615

@@ -91,4 +90,3 @@ fn _approve_and_execute_action(
9190
}
9291
```
9392

94-
<!-- docs:end:use_authwit -->

docs/pages/aztec-nr/language-description/calling-other-contracts.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
- Stealthifying Addresses
2121
- Custom Stealth Addresses
2222

23-
<!-- docs:start:call_contracts -->
2423

2524
This guide shows you how to call functions in other contracts from your Aztec smart contracts, enabling contract composability and interaction.
2625

@@ -83,11 +82,10 @@ OtherContract::at(contract_address)
8382
```
8483

8584
:::info
86-
Public functions always execute after private execution completes. Learn more in the [concepts overview](../../concepts/index.md).
85+
Public functions always execute after private execution completes. Learn more in the concepts overview.
8786
:::
8887

8988
### Use other call types
9089

91-
Explore additional call types for specialized use cases in the [call types reference](../../concepts/call_types.md).
90+
Explore additional call types for specialized use cases in the call types reference.
9291

93-
<!-- docs:end:call_contracts -->

docs/pages/aztec-nr/language-description/contract-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- Events
99
- See the dedicated section below
1010

11-
A contract is a collection of persistent state variables and [functions](./functions/index.md) which may manipulate these variables. Functions and state variables within a contract's scope are said to belong to that contract. A contract can only access and modify its own state. If a contract wishes to access or modify another contract's state, it must make a call to an external function of the other contract. For anything to happen on the Aztec network, an external function of a contract needs to be called.
11+
A contract is a collection of persistent state variables and functions which may manipulate these variables. Functions and state variables within a contract's scope are said to belong to that contract. A contract can only access and modify its own state. If a contract wishes to access or modify another contract's state, it must make a call to an external function of the other contract. For anything to happen on the Aztec network, an external function of a contract needs to be called.
1212

1313
## Contract
1414

docs/pages/aztec-nr/language-description/cross-chain-interactions.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- An Aztec contract project set up with `aztec-nr` dependency
1414
- Understanding of Aztec L1/L2 architecture
1515
- Access to Ethereum development environment for L1 contracts
16-
- Deployed portal contract on L1 (see [token bridge tutorial](../../tutorials/js_tutorials/token_bridge.md))
16+
- Deployed portal contract on L1 (see token bridge tutorial)
1717

1818
## Send messages from L1 to L2
1919

@@ -195,6 +195,5 @@ bytes memory message = abi.encodeWithSignature(
195195

196196
## Next steps
197197

198-
Follow the [cross-chain messaging tutorial](../../tutorials/js_tutorials/token_bridge.md) for a complete implementation example.
198+
Follow the cross-chain messaging tutorial for a complete implementation example.
199199

200-
<!-- docs:end:communicate_cross_chain -->

0 commit comments

Comments
 (0)