Skip to content

Commit 41d5da9

Browse files
authored
chore(docs): fix broken anchor tags across versioned docs (#21697)
## Summary - Fix 6 types of broken markdown anchor links across 20 files in versioned and source docs - Add missing `## 4.1.0-rc.2` version heading in migration notes ### Anchor fixes | Broken anchor | Fixed anchor | |---|---| | `#after-expansion` | `#private-functions-externalprivate` | | `#private-functions-private` | `#private-functions-externalprivate` | | `#initializer-functions` | `#define-initializer-functions` | | `#aztec-validator-keys\|valkeys` | `#aztec-validator-keysvalkeys` | | `#delayed-public-mutable` | `#delayedpublicmutable` | | `#fee-payment-contracts-fpc` | `#use-fee-payment-contracts` | ## Test plan - [ ] Verify anchor links resolve correctly in local dev server - [ ] Confirm migration notes heading matches versioned copy 🤖 Generated with [Claude Code](https://claude.com/claude-code)
2 parents 4cbe818 + 9e63a97 commit 41d5da9

File tree

16 files changed

+20
-18
lines changed

16 files changed

+20
-18
lines changed

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-nr/framework-description/functions/context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ The `args_hash` is the result of pedersen hashing all of a function's inputs.
174174

175175
### Return Values
176176

177-
The return values are a set of values that are returned from an applications execution to be passed to other functions through the kernel. Developers do not need to worry about passing their function return values to the `context` directly as `Aztec.nr` takes care of it for you. See the documentation surrounding `Aztec.nr` [macro expansion](./attributes.md#after-expansion) for more details.
177+
The return values are a set of values that are returned from an applications execution to be passed to other functions through the kernel. Developers do not need to worry about passing their function return values to the `context` directly as `Aztec.nr` takes care of it for you. See the documentation surrounding `Aztec.nr` [macro expansion](./attributes.md#private-functions-externalprivate) for more details.
178178

179179
```rust
180180
return_values : BoundedVec\<Field, RETURN_VALUES_LENGTH\>,

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-nr/framework-description/functions/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tags: [functions]
55
description: Overview of Aztec contract functions, including private, public, and utility function types.
66
---
77

8-
Functions serve as the building blocks of smart contracts. Functions can be either **public**, ie they are publicly available for anyone to see and can directly interact with public state, or **private**, meaning they are executed completely client-side in the [PXE](../../../foundational-topics/pxe/index.md). Read more about how private functions work [here](./attributes.md#private-functions-private).
8+
Functions serve as the building blocks of smart contracts. Functions can be either **public**, ie they are publicly available for anyone to see and can directly interact with public state, or **private**, meaning they are executed completely client-side in the [PXE](../../../foundational-topics/pxe/index.md). Read more about how private functions work [here](./attributes.md#private-functions-externalprivate).
99

1010
Currently, any function is "mutable" in the sense that it might alter state. However, we also support static calls, similarly to EVM. A static call is essentially a call that does not alter state (it keeps state static).
1111

@@ -22,7 +22,7 @@ There are also special oracle functions, which can get data from outside of the
2222
## Learn more about functions
2323

2424
- [How function visibility works in Aztec](./visibility.md)
25-
- How to write an [initializer function](./how_to_define_functions.md#initializer-functions)
25+
- How to write an [initializer function](./how_to_define_functions.md#define-initializer-functions)
2626
- [Oracles](../advanced/protocol_oracles.md) and how Aztec smart contracts might use them
2727
- [How functions work under the hood](./attributes.md)
2828

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/cli/aztec_cli_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ sidebar_position: 1
6060
- [aztec start](#aztec-start)
6161
- [aztec trigger-seed-snapshot](#aztec-trigger-seed-snapshot)
6262
- [aztec update](#aztec-update)
63-
- [aztec validator-keys|valKeys](#aztec-validator-keys|valkeys)
63+
- [aztec validator-keys|valKeys](#aztec-validator-keysvalkeys)
6464
- [aztec vote-on-governance-proposal](#aztec-vote-on-governance-proposal)
6565
## aztec
6666

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/foundational-topics/call_types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ public_checks = { git = "https://github.com/AztecProtocol/aztec-packages/", tag
225225

226226
Even with the public checks contract, achieving good privacy is hard.
227227
For example, if the value being checked against is unique and stored in the contract's public storage, it's then simple to find private transactions that are using that value in the enqueued public reads, and therefore link them to this contract.
228-
For this reason it is encouraged to try to avoid public function calls and instead privately read [Delayed Public Mutable](../aztec-nr/framework-description/state_variables.md#delayed-public-mutable) state when possible.
228+
For this reason it is encouraged to try to avoid public function calls and instead privately read [Delayed Public Mutable](../aztec-nr/framework-description/state_variables.md#delayedpublicmutable) state when possible.
229229

230230
### Public Execution
231231

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/foundational-topics/fees.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Fee Juice uses an enshrined `FeeJuicePortal` contract on Ethereum for bridging,
9494
9595
An account with Fee Juice can pay for its transactions directly. A new account can even pay for its own deployment transaction, provided Fee Juice was bridged to its address before deployment.
9696
97-
Alternatively, accounts can use [fee-paying contracts (FPCs)](../aztec-js/how_to_pay_fees.md#fee-payment-contracts-fpc) to pay for transactions. FPCs accept tokens and pay fees in Fee Juice on behalf of users. Common patterns include:
97+
Alternatively, accounts can use [fee-paying contracts (FPCs)](../aztec-js/how_to_pay_fees.md#use-fee-payment-contracts) to pay for transactions. FPCs accept tokens and pay fees in Fee Juice on behalf of users. Common patterns include:
9898
9999
- **Sponsored FPCs**: Pay fees unconditionally, enabling free transactions for users
100100
- **Token-accepting FPCs**: Accept a specific token in exchange for paying fees

docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/aztec-nr/framework-description/functions/context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ The `args_hash` is the result of pedersen hashing all of a function's inputs.
170170

171171
### Return Values
172172

173-
The return values are a set of values that are returned from an applications execution to be passed to other functions through the kernel. Developers do not need to worry about passing their function return values to the `context` directly as `Aztec.nr` takes care of it for you. See the documentation surrounding `Aztec.nr` [macro expansion](./attributes.md#after-expansion) for more details.
173+
The return values are a set of values that are returned from an applications execution to be passed to other functions through the kernel. Developers do not need to worry about passing their function return values to the `context` directly as `Aztec.nr` takes care of it for you. See the documentation surrounding `Aztec.nr` [macro expansion](./attributes.md#private-functions-externalprivate) for more details.
174174

175175
```rust
176176
return_values : BoundedVec\<Field, RETURN_VALUES_LENGTH\>,

docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/aztec-nr/framework-description/functions/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tags: [functions]
55
description: Overview of Aztec contract functions, including private, public, and utility function types.
66
---
77

8-
Functions serve as the building blocks of smart contracts. Functions can be either **public**, ie they are publicly available for anyone to see and can directly interact with public state, or **private**, meaning they are executed completely client-side in the [PXE](../../../foundational-topics/pxe/index.md). Read more about how private functions work [here](./attributes.md#private-functions-private).
8+
Functions serve as the building blocks of smart contracts. Functions can be either **public**, ie they are publicly available for anyone to see and can directly interact with public state, or **private**, meaning they are executed completely client-side in the [PXE](../../../foundational-topics/pxe/index.md). Read more about how private functions work [here](./attributes.md#private-functions-externalprivate).
99

1010
Currently, any function is "mutable" in the sense that it might alter state. However, we also support static calls, similarly to EVM. A static call is essentially a call that does not alter state (it keeps state static).
1111

@@ -22,7 +22,7 @@ There are also special oracle functions, which can get data from outside of the
2222
## Learn more about functions
2323

2424
- [How function visibility works in Aztec](./visibility.md)
25-
- How to write an [initializer function](./how_to_define_functions.md#initializer-functions)
25+
- How to write an [initializer function](./how_to_define_functions.md#define-initializer-functions)
2626
- [Oracles](../advanced/protocol_oracles.md) and how Aztec smart contracts might use them
2727
- [How functions work under the hood](./attributes.md)
2828

docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/cli/aztec_cli_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ sidebar_position: 1
6767
- [aztec test](#aztec-test)
6868
- [aztec trigger-seed-snapshot](#aztec-trigger-seed-snapshot)
6969
- [aztec update](#aztec-update)
70-
- [aztec validator-keys|valKeys](#aztec-validator-keys|valkeys)
70+
- [aztec validator-keys|valKeys](#aztec-validator-keysvalkeys)
7171
- [aztec vote-on-governance-proposal](#aztec-vote-on-governance-proposal)
7272
## aztec
7373

docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/foundational-topics/call_types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ public_checks = { git = "https://github.com/AztecProtocol/aztec-packages/", tag
214214

215215
Even with the public checks contract, achieving good privacy is hard.
216216
For example, if the value being checked against is unique and stored in the contract's public storage, it's then simple to find private transactions that are using that value in the enqueued public reads, and therefore link them to this contract.
217-
For this reason it is encouraged to try to avoid public function calls and instead privately read [Delayed Public Mutable](../aztec-nr/framework-description/state_variables.md#delayed-public-mutable) state when possible.
217+
For this reason it is encouraged to try to avoid public function calls and instead privately read [Delayed Public Mutable](../aztec-nr/framework-description/state_variables.md#delayedpublicmutable) state when possible.
218218

219219
### Public Execution
220220

docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/foundational-topics/fees.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Fee Juice uses an enshrined `FeeJuicePortal` contract on Ethereum for bridging,
9494
9595
An account with Fee Juice can pay for its transactions directly. A new account can even pay for its own deployment transaction, provided Fee Juice was bridged to its address before deployment.
9696
97-
Alternatively, accounts can use [fee-paying contracts (FPCs)](../aztec-js/how_to_pay_fees.md#fee-payment-contracts-fpc) to pay for transactions. FPCs accept tokens and pay fees in Fee Juice on behalf of users. Common patterns include:
97+
Alternatively, accounts can use [fee-paying contracts (FPCs)](../aztec-js/how_to_pay_fees.md#use-fee-payment-contracts) to pay for transactions. FPCs accept tokens and pay fees in Fee Juice on behalf of users. Common patterns include:
9898
9999
- **Sponsored FPCs**: Pay fees unconditionally, enabling free transactions for users
100100
- **Token-accepting FPCs**: Accept a specific token in exchange for paying fees

0 commit comments

Comments
 (0)