-
Notifications
You must be signed in to change notification settings - Fork 598
chore(docs): moving tutorials and quick starts around, spinning off codespaces page #6777
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
215a23f
chore(docs): moving tutorials and quick starts around, spinning off c…
signorecello c9a5ef2
Update counter_contract.md
signorecello 5bc0098
Apply suggestions from code review
signorecello 06324be
changes from PR
signorecello b9775d2
changes from PR
signorecello 9d8c1a6
changes from PR
signorecello 15d89ba
removing nasty space
signorecello 9e7b663
Update docs/docs/tutorials/aztecjs-getting-started.md
signorecello 7697ae0
include code stuff
signorecello a47b60c
more include_codes
critesjosh f735f70
Merge branch 'master' into zpedro/getting_started_reorder
critesjosh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,3 +24,4 @@ yarn-error.log* | |
|
|
||
| docs/reference/aztecjs | ||
| docs/reference/smart_contract_reference/aztec-nr | ||
| test-results | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "label": "Aztec", | ||
| "position": 0, | ||
| "position": 1, | ||
| "collapsible": true, | ||
| "collapsed": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Codespaces | ||
| sidebar_position: 0 | ||
| draft: true | ||
| --- | ||
signorecello marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| All machines are different, and you may not want to run the sandbox locally (for example when using Windows). We thought about you exactly ❤️ | ||
|
|
||
| [Codespaces](https://github.com/features/codespaces) are a quick way to develop: they provision a remote machine with all tooling you need for Aztec in just a few minutes. We're big fans, so we prepared some prebuilt images to make it easier and faster. | ||
|
|
||
| Just choose a boilerplate and click "create new codespace": | ||
|
|
||
| [](https://codespaces.new/AztecProtocol/aztec-packages?devcontainer_path=.devcontainer%2Freact%2Fdevcontainer.json) [](https://codespaces.new/AztecProtocol/aztec-packages?devcontainer_path=.devcontainer%2Fvanilla%2Fdevcontainer.json) [](https://codespaces.new/AztecProtocol/aztec-packages?devcontainer_path=.devcontainer%2Ftoken%2Fdevcontainer.json) | ||
|
|
||
| This creates a codespace with a prebuilt image containing one of the "Aztec Boxes" and a development network (sandbox). | ||
| - You can develop directly on the codespace, push it to a repo, make yourself at home. | ||
| - You can also just use the sandbox that comes with it. The URL will be logged, you just need to use it as your `PXE_URL`. | ||
|
|
||
| You can then start, stop, or see the logs of your sandbox just by calling `sandbox` or `npx aztec-app sandbox`. Run `sandbox -h` for a list of commands. | ||
|
|
||
| ## More about codespaces | ||
|
|
||
| Codespaces are way more powerful than you may initially think. For example, you can connect your local `vscode` to a remote codespace, for a fully contained development environment that doesn't use any of your computer resources! | ||
|
|
||
| Visit the [codespaces documentation](https://docs.github.com/en/codespaces/overview) for more specific documentation around codespaces. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| title: Manual install | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| You can have some more control over the sandbox by installing it manually through the underlying script used by [`npx aztec-app`](../getting_started.md). | ||
|
|
||
| This involves some knowledge on Docker if you want to stop, restart, or detach from logs. But it also gives you better control over things such as environment variables. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Node.js >= v18 (recommend installing with [nvm](https://github.com/nvm-sh/nvm)) | ||
| - Docker (visit [this page of the Docker docs](https://docs.docker.com/get-docker/) on how to install it) | ||
|
|
||
| ### Install the sandbox | ||
|
|
||
| To install the latest Sandbox version, run: | ||
|
|
||
| ```bash | ||
| bash -i <(curl -s install.aztec.network) | ||
| ``` | ||
|
|
||
| This will install the following tools: | ||
|
|
||
| - **aztec** - launches various infrastructure subsystems (sequencer, prover, pxe, etc). | ||
| - **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: | ||
|
|
||
| ```bash | ||
| aztec-sandbox | ||
| ``` | ||
|
|
||
| ### Have fun | ||
|
|
||
| **Congratulations, you have just installed and run the Aztec Sandbox!** | ||
|
|
||
| ```bash | ||
| /\ | | | ||
| / \ ___| |_ ___ ___ | ||
| / /\ \ |_ / __/ _ \/ __| | ||
| / ____ \ / /| || __/ (__ | ||
| /_/___ \_\/___|\__\___|\___| | ||
|
|
||
| ``` | ||
|
|
||
| In the terminal, you will see some logs: | ||
|
|
||
| 1. Sandbox version | ||
| 2. Contract addresses of rollup contracts | ||
| 3. PXE (private execution environment) setup logs | ||
| 4. Initial accounts that are shipped with the sandbox and can be used in tests | ||
|
|
||
| ## Running Aztec PXE / Node / P2P-Bootstrap node | ||
|
|
||
| If you wish to run components of the Aztec network stack separately, you can use the `aztec start` command with various options for enabling components. | ||
|
|
||
| ```bash | ||
| aztec start --node [nodeOptions] --pxe [pxeOptions] --archiver [archiverOptions] --sequencer [sequencerOptions] --prover [proverOptions] ----p2p-bootstrap [p2pOptions] | ||
| ``` | ||
|
|
||
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/docs/tutorials/contract_tutorials/advanced/_category_.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "label": "Advanced", | ||
| "position": 3, | ||
| "position": 5, | ||
| "collapsible": true, | ||
| "collapsed": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/docs/tutorials/contract_tutorials/crowdfunding_contract.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.