Skip to content

Commit a8a5b78

Browse files
committed
refactor(docs): local network page rework
This removes the page and adds a simple snippet for the network prereq
1 parent 940351a commit a8a5b78

20 files changed

Lines changed: 52 additions & 450 deletions

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-js/how_to_deploy_contract.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ This guide shows you how to deploy compiled contracts to Aztec using the generat
1111

1212
Deploying a contract to Aztec involves publishing the contract class (the bytecode) and creating a contract instance at a specific address. The generated TypeScript classes handle this process through an API: you call `deploy()` with constructor arguments and `send()` with transaction options to deploy and get the contract instance. The contract address is deterministically computed from the contract class, constructor arguments, salt, and deployer address.
1313

14+
import { General } from '@site/src/components/Snippets/general_snippets';
15+
1416
## Prerequisites
1517

1618
- Compiled contract artifacts (see [How to Compile](../aztec-nr/compiling_contracts.md))
17-
- [Connected to a network](./how_to_connect_to_local_network.md) with a `EmbeddedWallet` instance and funded accounts
19+
- <General.AztecJSPrerequisites />
1820
- TypeScript project set up
1921

2022
## Generate TypeScript bindings

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-js/how_to_pay_fees.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ sidebar_position: 7
55
description: Pay transaction fees on Aztec, understand mana costs, estimate gas, and retrieve fees from receipts.
66
---
77

8-
import { Fees } from '@site/src/components/Snippets/general_snippets';
8+
import { General, Fees } from '@site/src/components/Snippets/general_snippets';
99

1010
This guide walks you through paying transaction fees on Aztec using various payment methods.
1111

1212
## Prerequisites
1313

14-
- [Connected to a network](./how_to_connect_to_local_network.md) with a `EmbeddedWallet` instance and funded accounts
14+
- <General.AztecJSPrerequisites />
1515
- Understanding of [fee concepts](../foundational-topics/fees.md)
1616

1717
:::info

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-js/how_to_read_data.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ description: How to read data from contracts including simulating functions, rea
77

88
This guide shows you how to read data from Aztec contracts in TypeScript, including simulating function calls, reading raw logs, and retrieving typed events.
99

10+
import { General } from '@site/src/components/Snippets/general_snippets';
11+
1012
## Prerequisites
1113

12-
- [Connected to a network](./how_to_connect_to_local_network.md) with a `EmbeddedWallet` instance and funded accounts
14+
- <General.AztecJSPrerequisites />
1315
- A deployed contract instance (see [How to Deploy a Contract](./how_to_deploy_contract.md))
1416

1517
## Simulating functions

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-js/how_to_send_transaction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ This guide shows you how to send transactions to smart contracts on Aztec.
1111

1212
Transactions on Aztec execute contract functions that modify state. Unlike simple reads, transactions go through private execution on your device, proving, and then submission to the network for inclusion in a block. You can send single transactions, batch multiple calls atomically, and query transaction status after submission.
1313

14+
import { General } from '@site/src/components/Snippets/general_snippets';
15+
1416
## Prerequisites
1517

16-
- [Connected to a network](./how_to_connect_to_local_network.md) with a `EmbeddedWallet` instance and funded accounts
18+
- <General.AztecJSPrerequisites />
1719
- Deployed contract with its address and ABI (see [How to Deploy](./how_to_deploy_contract.md))
1820
- Understanding of [contract interactions](../aztec-nr/framework-description/calling_contracts.md)
1921

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/aztec-js/how_to_use_authwit.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ Therefore it is recommended to read the `aztec-nr` [guide on authwitnesses](../a
1515

1616
:::
1717

18+
import { General } from '@site/src/components/Snippets/general_snippets';
19+
1820
## Prerequisites
1921

20-
- [Connected to a network](./how_to_connect_to_local_network.md) with a `EmbeddedWallet` instance and funded accounts
22+
- <General.AztecJSPrerequisites />
2123
- Contract with authwit validation (see [smart contract authwits](../aztec-nr/framework-description/authentication_witnesses.md))
2224
- Understanding of [authwit concepts](../foundational-topics/advanced/authwit.md)
2325

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/tutorials/contract_tutorials/recursive_verification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@ This utility computes the address of the pre-deployed sponsored FPC contract. Th
916916

917917
### Start the Local Network
918918

919-
In a separate terminal, start the [Aztec local network](../local_network.md):
919+
In a separate terminal, start the [Aztec local network](../../../getting_started_on_local_network.md):
920920

921921
```bash
922922
aztec start --local-network

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/tutorials/js_tutorials/aztecjs-getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ references: ["docs/examples/ts/aztecjs_getting_started/index.ts"]
77

88
import Image from "@theme/IdealImage";
99

10-
In this guide, we will retrieving the local network and deploy a pre-written token contract to it using Aztec.js. [Check out the source code](https://github.com/AztecProtocol/aztec-packages/blob/master/noir-projects/noir-contracts/contracts/app/token_contract/src/main.nr). We will then use Aztec.js to interact with this contract and transfer tokens.
10+
In this guide, we will retrieve the local network and deploy a pre-written token contract to it using Aztec.js. [Check out the source code](https://github.com/AztecProtocol/aztec-packages/blob/master/noir-projects/noir-contracts/contracts/app/token_contract/src/main.nr). We will then use Aztec.js to interact with this contract and transfer tokens.
1111

12-
Before starting, make sure to be running Aztec local network at version 4.0.0-devnet.2-patch.1. Check out [the guide](../../tutorials/local_network.md) for info about that.
12+
Before starting, make sure to be running Aztec local network at version 4.0.0-devnet.2-patch.1. Check out [the guide](../../../getting_started_on_local_network.md) for info about that.
1313

1414
## Set up the project
1515

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/docs/tutorials/local_network.md

Lines changed: 0 additions & 214 deletions
This file was deleted.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Before diving into the setup, it's important to understand the differences betwe
2828
- No automatic test accounts
2929

3030
:::info
31-
If you're new to Aztec and want to understand local development first, check out the [local network guide](./docs/tutorials/local_network.md).
31+
If you're new to Aztec and want to understand local development first, check out the [local network guide](./getting_started_on_local_network.md).
3232
:::
3333

3434
## Prerequisites
@@ -189,7 +189,7 @@ For complete Devnet technical details including RPC endpoints, contract addresse
189189
190190
## Next Steps
191191
192-
- **New to Aztec?** Start with the [local network tutorial](./docs/tutorials/local_network.md) for faster development
192+
- **New to Aztec?** Start with the [local network guide](./getting_started_on_local_network.md) for faster development
193193
- **Ready for production testing?** Continue using devnet
194194
- **Learn more:** Check out our [tutorials](./docs/tutorials/contract_tutorials/counter_contract.md)
195195
- **Explore:** Visit [Aztec Playground](https://play.aztec.network/)

docs/docs-developers/docs/aztec-js/how_to_deploy_contract.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ This guide shows you how to deploy compiled contracts to Aztec using the generat
1111

1212
Deploying a contract to Aztec involves publishing the contract class (the bytecode) and creating a contract instance at a specific address. The generated TypeScript classes handle this process through an API: you call `deploy()` with constructor arguments and `send()` with transaction options to deploy and get the contract instance. The contract address is deterministically computed from the contract class, constructor arguments, salt, and deployer address.
1313

14+
import { General } from '@site/src/components/Snippets/general_snippets';
15+
1416
## Prerequisites
1517

1618
- Compiled contract artifacts (see [How to Compile](../aztec-nr/compiling_contracts.md))
17-
- [Connected to a network](./how_to_connect_to_local_network.md) with a `EmbeddedWallet` instance and funded accounts
19+
- <General.AztecJSPrerequisites />
1820
- TypeScript project set up
1921

2022
## Generate TypeScript bindings

0 commit comments

Comments
 (0)