Skip to content

Commit

Permalink
changes from PR
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello committed Jun 25, 2024
1 parent 06324be commit b9775d2
Show file tree
Hide file tree
Showing 9 changed files with 372 additions and 10 deletions.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ yarn-error.log*

docs/reference/aztecjs
docs/reference/smart_contract_reference/aztec-nr
test-results
2 changes: 0 additions & 2 deletions docs/docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ title: Quickstart

The easiest way to start developing on Aztec locally is through `npx aztec-app`. This is a convenient way of installing the development environment (A.K.A. Sandbox) and starting new projects from a boilerplate.

If you'd like to develop remotely (for example, if you're on Windows or have trouble working with Docker), follow the [codespaces guide](./getting_started/codespaces.md).

To locally install the Sandbox without other tools, see [here](./getting_started/manual_install.md).

## Prerequisites
Expand Down
1 change: 1 addition & 0 deletions docs/docs/getting_started/codespaces.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Codespaces
sidebar_position: 0
draft: true
---

All machines are different, and you may not want to run the sandbox locally (for example when using Windows). We thought about you exactly ❤️
Expand Down
8 changes: 8 additions & 0 deletions docs/docs/getting_started/manual_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,14 @@ aztec start --node [nodeOptions] --pxe [pxeOptions] --archiver [archiverOptions]
Starting the aztec node alongside a PXE, sequencer or archiver, will attach the components to the node.Eg if you want to run a PXE separately to a node, you can [read this guide](../aztec/concepts/pxe/index.md)/
## Update the sandbox
To update the sandbox, you can just run:
```bash
aztec-up
```
## Next steps
Visit the [sandbox reference](../reference/sandbox_reference/index.md) for more info on which environment variables you can set, which cheat codes you can use, and learn about what exactly is the Aztec Sandbox.
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ export class TokenContract extends ContractBase {
}
```

Read more about interacting with contracts using `aztec.js` [here](../../tutorials/contract_tutorials/counter_contract.md).
Read more about interacting with contracts using `aztec.js` [here](../../tutorials/aztecjs-getting-started.md).

### Aztec.nr interfaces

Expand Down
Loading

0 comments on commit b9775d2

Please sign in to comment.