Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tweaks for release #6129

Merged
merged 9 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions aztec-up/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ a users `PATH` variable in their shell startup script so they can be found.
- `aztec-nargo` - A build of `nargo` from `noir` that is guaranteed to be version aligned. Provides compiler, lsp and more.
- `aztec-sandbox` - A wrapper around docker-compose that launches services needed for sandbox testing.
- `aztec-up` - A tool to upgrade the aztec toolchain to the latest, or specific versions.
- `aztec-builder` - A useful tool for projects to generate ABIs and update their dependencies.

After installed, you can use `aztec-up` to upgrade or install specific versions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ This guide assumes you have followed the [quickstart](./quickstart.md).

We will deploy a pre-compiled token contract, and send tokens privately, using the Sandbox.

:::info
Find the full code [here](https://github.com/AztecProtocol/dev-rel/tree/main/tutorials/sandbox-tutorial/token)
:::

We will create a `yarn` project called `token` (although `npm` works fine too).

1. Initialize a yarn project
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/developers/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ This will install the following:
- **aztec-nargo** - aztec's build of nargo, the noir compiler toolchain.
- **aztec-sandbox** - a wrapper around docker-compose that launches services needed for sandbox testing.
- **aztec-up** - a tool to upgrade the aztec toolchain to the latest, or specific versions.
- **aztec-builder** - A useful tool for projects to generate ABIs and update their dependencies.


Once these have been installed, to start the sandbox, run:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This will install the following:
- **aztec-nargo** - aztec's build of nargo, the noir compiler toolchain.
- **aztec-sandbox** - a wrapper around docker-compose that launches services needed for sandbox testing.
- **aztec-up** - a tool to upgrade the aztec toolchain to the latest, or specific versions.
- **aztec-builder** - A useful tool for projects to generate ABIs and update their dependencies.

Once these have been installed, to start the sandbox, run:

Expand Down
4 changes: 1 addition & 3 deletions docs/docs/developers/tutorials/token_portal/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ In this step, we’re going to

We recommend going through this setup to fully understand where things live.

However if you’d rather skip this part, our dev-rels repo contains the starter code here.

## Prerequisites

- [node v18+](https://github.com/tj/n)
Expand All @@ -35,7 +33,7 @@ mkdir aztec-token-bridge
cd aztec-token-bridge && mkdir packages
```

We will hold our projects inside of `packages` to follow the design of the project in the [repo](https://github.com/AztecProtocol/dev-rel/tree/main/tutorials/token-bridge-e2e).
We will hold our projects inside of `packages` to follow the design of other projects.

## Create a noir project

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/developers/tutorials/uniswap/setup.md
critesjosh marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ title: Setup & Installation

This tutorial builds on top of the project created in the previous tutorial. It can exist on its own, but for our sake it is much easier to utilize the existing L1 contracts that we already have in place.

:::warning
Note: This document does not appear in the sidebar.
Also note that the code linked in the dev-rel repo is not as up to date as the aztec-packages monorepo.
If you don’t have this, you can find the code for it [in our dev-rels repo](https://github.com/AztecProtocol/dev-rel/tree/main/tutorials/token-bridge-e2e).
:::warning

# Uniswap contract

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developers/tutorials/writing_token_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,6 @@ https://github.com/AztecProtocol/aztec-packages/blob/#include_aztec_version/yarn

### Token Bridge Contract

The [token bridge tutorial](https://github.com/AztecProtocol/dev-rel/tree/main/tutorials/token-bridge) is a great follow up to this one.
The [token bridge tutorial](./token_portal/main) is a great follow up to this one.

It builds on the Token contract described here and goes into more detail about Aztec contract composability and Ethereum (L1) and Aztec (L2) cross-chain messaging.
14 changes: 7 additions & 7 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -359,13 +359,13 @@ const sidebars = {
"developers/contracts/writing_contracts/storage/storage_slots",
],
},
{
label: "Accounts and Account Contracts",
type: "category",
items: [
"developers/contracts/writing_contracts/accounts/write_accounts_contract",
],
},
// {
critesjosh marked this conversation as resolved.
Show resolved Hide resolved
// label: "Accounts and Account Contracts",
// type: "category",
// items: [
// "developers/contracts/writing_contracts/accounts/write_accounts_contract",
// ],
// },
{
label: "Events",
type: "category",
Expand Down
4 changes: 4 additions & 0 deletions noir/noir-repo/docs/docs/how_to/how-to-oracles.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ This guide shows you how to use oracles in your Noir program. For the sake of cl

For reference, you can find the snippets used in this tutorial on the [Aztec DevRel Repository](https://github.com/AztecProtocol/dev-rel/tree/main/code-snippets/how-to-oracles).
critesjosh marked this conversation as resolved.
Show resolved Hide resolved

:::warning
note that the code linked in the dev-rel repo is not as up to date as the aztec-packages monorepo.
:::

## Rundown

This guide has 3 major steps:
Expand Down
Loading