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

feat(docs): Sandbox -> testnet guides + "try testnet" collation page #11299

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion docs/docs/developers/guides/js_apps/call_view_function.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You should have a wallet to act as the caller, and a contract that has been depl

You can learn how to create wallets from [this guide](./create_account.md).

You can learn how to deploy a contract [here](./deploy_contract.md).
You can learn how to deploy a contract [here](../smart_contracts/how_to_deploy_contract.md).

## Relevant imports

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developers/guides/js_apps/create_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ You will need to import these libraries:

#include_code create_wallet yarn-project/end-to-end/src/composed/docs_examples.test.ts typescript

Now you have a new wallet in your PXE! To learn how to use this wallet to deploy a contract, read [this guide](./deploy_contract.md).
Now you have a new wallet in your PXE! To learn how to use this wallet to deploy a contract, read [this guide](../smart_contracts/how_to_deploy_contract.md).
26 changes: 0 additions & 26 deletions docs/docs/developers/guides/js_apps/deploy_contract.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs/developers/guides/js_apps/send_transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You should have a wallet to act as the transaction sender, and a contract that h

You can learn how to create wallets from [this guide](./create_account.md).

You can learn how to deploy a contract [here](./deploy_contract.md).
You can learn how to deploy a contract [here](../smart_contracts/how_to_deploy_contract.md).

## Relevant imports

Expand Down
1 change: 0 additions & 1 deletion docs/docs/developers/guides/js_apps/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,6 @@ You can then use the `warp` function on the EthCheatCodes to progress the underl

- [How to call a view transactions in Aztec.js](./call_view_function.md)
- [How to send a transactions in Aztec.js](./send_transaction.md)
- [How to deploy a contract in Aztec.js](./deploy_contract.md)
- [How to create an account in Aztec.js](./create_account.md)
- [Cheat codes](../../reference/environment_reference/cheat_codes.md)
- [How to compile a contract](../smart_contracts/how_to_compile_contract.md).
12 changes: 12 additions & 0 deletions docs/docs/developers/guides/local_env/sandbox_to_testnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Moving from Sandbox to Testnet
sidebar_position: 6
draft: true
tags: [sandbox, testnet]
---

This is a guide for developers who have started building on the sandbox and wish to move their application to testnet.

## Deploy to testnet

## Connect your PXE to Testnet
1 change: 1 addition & 0 deletions docs/docs/migration_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Migration notes
description: Read about migration notes from previous versions, which could solve problems while updating
keywords: [sandbox, aztec, notes, migration, updating, upgrading]
tags: [migration, updating, sandbox]
---

Aztec is in full-speed development. Literally every version breaks compatibility with the previous ones. This page attempts to target errors and difficulties you might encounter when upgrading, and how to resolve them.
Expand Down
28 changes: 28 additions & 0 deletions docs/docs/try_testnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Try Testnet
keywords: [testnet, aztec, migration]
tags: [testnet, migration]
---

The Aztec Testnet is live! You can read the announcement [here](TODO). If you would like to contribute to the continuous testing of the Aztec Network, you can take part in:

- [Running a validator node](#validator-node)
- [Running a prover node](#prover-node)
- [Deploying an app onto testnet](#develop-on-aztec-testnet)

## Run a testnet node

It is recommended to read the [full "Run a node" section](./run_node/concepts/governance/governance.md]) to fully understand how decentralization and governance works on the Aztec testnet.

### Validator node

Follow the [sequencer guide](./run_node/guides/run_nodes/how_to_run_validator_sequencer.md).

### Prover node

Follow the [prover guide](./run_node/guides/run_nodes/how_to_run_prover.md).

## Develop on Aztec Testnet

Follow the [sandbox -> testnet migration guide](./developers/guides/local_env/sandbox_to_testnet.md).

5 changes: 5 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,11 @@ const config = {
label: "Install Sandbox",
position: "right",
},
{
to: "/try_testnet",
label: "Try Testnet",
position: "right",
},
{
type: "dropdown",
label: "Resources",
Expand Down
Loading