Skip to content

Commit 2f3d821

Browse files
authored
fix(docs): polishing rough edges (#19245)
On this PR we polish some rough edges: - We unify the "CLI" references under the "CLI" on sidebar. Talked with @critesjosh. - We obviously modify auto-generation of references to work with the new structure. - We've moved the sign with FaceID into "Tutorials" (yikes, it needs a better place) - And we improve the installation of aztec's tooling by directly using the version that is intended. This avoids having some problems than what we have right now (the stable version of the install sh tries to install `aztec-nargo`, but that install doesn't exist for the latest version, so it breaks). This makes it so we point exactly to the install script we need for the intended version.
2 parents d627e73 + cbbe8eb commit 2f3d821

File tree

23 files changed

+63
-765
lines changed

23 files changed

+63
-765
lines changed

docs/docs-developers/docs/aztec-cli/_category_.json

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

docs/docs-developers/docs/aztec-cli/local-network-reference.md

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

docs/docs-developers/docs/aztec-nr/framework-description/advanced/how_to_profile_transactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This guide shows you how to profile your Aztec transactions to identify bottlene
99

1010
## Prerequisites
1111

12-
- `aztec` command installed ([see installation](../../../aztec-cli/local-network-reference.md))
12+
- `aztec` command installed ([see installation](../../../../getting_started_on_local_network.md))
1313
- `aztec-wallet` installed
1414
- Aztec contract deployed and ready to test
1515
- Basic understanding of proving and gate counts

docs/docs-developers/docs/wallet-cli/_category_.json renamed to docs/docs-developers/docs/cli/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Wallet CLI",
2+
"label": "CLI",
33
"position": 5,
44
"collapsible": true,
55
"collapsed": true

docs/docs-developers/docs/aztec-cli/cli_reference.md renamed to docs/docs-developers/docs/cli/aztec_cli_reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Reference
2+
title: Aztec Reference
33
description: Comprehensive auto-generated reference for the Aztec CLI command-line interface with all commands and options.
44
tags: [cli, reference, autogenerated]
5-
sidebar_position: 2
5+
sidebar_position: 1
66
---
77

88
# Aztec CLI Reference

docs/docs-developers/docs/wallet-cli/cli_wallet_reference.md renamed to docs/docs-developers/docs/cli/aztec_wallet_cli_reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Reference
2+
title: Aztec Wallet Reference
33
description: Comprehensive auto-generated reference for the Aztec Wallet CLI command-line interface with all commands and options.
44
tags: [cli, reference, autogenerated, wallet]
5-
sidebar_position: 10
5+
sidebar_position: 2
66
---
77

88
# Reference

docs/docs-developers/docs/resources/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Aztec is a privacy-first Layer 2 rollup on Ethereum. It supports smart contracts
1818

1919
`aztec` is a CLI tool (with an extensive set of parameters) that enables users to perform a wide range of tasks. It can: compile and test contracts, run a node, run a local network, execute tests, generate contract interfaces for javascript and more.
2020

21-
Full reference [here](../aztec-cli/cli_reference).
21+
Full reference [here](../cli/aztec_cli_reference).
2222

2323
### Aztec Wallet
2424

2525
The Aztec Wallet is a CLI wallet, `aztec-wallet`, that allows a user to manage accounts and interact with an Aztec network. It includes a PXE.
2626

27-
Full reference [here](../wallet-cli/cli_wallet_reference).
27+
Full reference [here](../cli/aztec_wallet_cli_reference).
2828

2929
### `aztec-up`
3030

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Contract Tutorials",
3-
"position": 1,
3+
"position": 2,
44
"collapsible": true,
55
"collapsed": true
6-
}
6+
}

docs/docs-developers/docs/tutorials/contract_tutorials/counter_contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Image from "@theme/IdealImage";
88

99
In this guide, we will create our first Aztec.nr smart contract. We will build a simple private counter, where you can keep your own private counter - so no one knows what ID you are at or when you increment! This contract will get you started with the basic setup and syntax of Aztec.nr, but doesn't showcase all of the awesome stuff Aztec is capable of.
1010

11-
This tutorial is compatible with the Aztec version `#include_aztec_version`. Install the correct version with `aztec-up -v #include_version_without_prefix`. Or if you'd like to use a different version, you can find the relevant tutorial by clicking the version dropdown at the top of the page.
11+
This tutorial is compatible with the Aztec version `#include_aztec_version`. Install the correct version with `bash -i <(curl -s https://install.aztec.network/#include_version_without_prefix/)`. Or if you'd like to use a different version, you can find the relevant tutorial by clicking the version dropdown at the top of the page.
1212

1313
## Prerequisites
1414

docs/docs-developers/docs/tutorials/contract_tutorials/token_contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This is an intermediate tutorial that assumes you have:
2222
- Completed the [Counter Contract tutorial](./counter_contract.md)
2323
- A Running Aztec local network (see the Counter tutorial for setup)
2424
- Basic understanding of Aztec.nr syntax and structure
25-
- Aztec toolchain installed (`aztec-up -v #include_version_without_prefix`)
25+
- Aztec toolchain installed (`bash -i <(curl -s https://install.aztec.network/#include_version_without_prefix/)`)
2626

2727
If you haven't completed the Counter Contract tutorial, please do so first as we'll skip the basic setup steps covered there.
2828

0 commit comments

Comments
 (0)