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

chore(docs): Fix a few links to docs #4260

Merged
merged 2 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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 boxes/blank-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ yarn install:noir
yarn install:sandbox
```

This sandbox requires [Docker](https://www.docker.com/) to be installed _and running_ locally. In the event the image needs updating, you can run `yarn install:sandbox` (see [sandbox docs](https://aztec-docs-dev.netlify.app/dev_docs/getting_started/sandbox) for more information.)
This sandbox requires [Docker](https://www.docker.com/) to be installed _and running_ locally. In the event the image needs updating, you can run `yarn install:sandbox` (see [sandbox docs](https://docs.aztec.network/developers/cli/main) for more information.)
jzaki marked this conversation as resolved.
Show resolved Hide resolved

In addition to the usual javascript dependencies, this project requires `nargo` (package manager) and `noir` (Aztec ZK smart contract language) in addition to `@aztec/aztec-cli`. The former two are installed by `yarn install:noir`.

Expand Down
2 changes: 1 addition & 1 deletion boxes/blank/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ yarn install:noir
yarn install:sandbox
```

This sandbox requires [Docker](https://www.docker.com/) to be installed _and running_ locally. In the event the image needs updating, you can run `yarn install:sandbox` (see [sandbox docs](https://aztec-docs-dev.netlify.app/dev_docs/getting_started/sandbox) for more information.)
This sandbox requires [Docker](https://www.docker.com/) to be installed _and running_ locally. In the event the image needs updating, you can run `yarn install:sandbox` (see [sandbox docs](https://docs.aztec.network/developers/cli/main) for more information.)
jzaki marked this conversation as resolved.
Show resolved Hide resolved

In addition to the usual javascript dependencies, this project requires `nargo` (package manager) and `noir` (a Domain Specific Language for SNARK proving systems) in addition to `@aztec/aztec-cli`. The former are installed within `yarn install:noir`.

Expand Down
54 changes: 27 additions & 27 deletions docs/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,87 +20,87 @@

[[redirects]]
from = "/dev_docs/aztec3/*"
to = "/dev_docs/aztec/overview"
to = "/learn/about_aztec/what_is_aztec"
jzaki marked this conversation as resolved.
Show resolved Hide resolved

[[redirects]]
from = "/dev_docs/contracts/types"
to = "/dev_docs/contracts/syntax/types"
to = "/developers/contracts/syntax/types"

[[redirects]]
from = "/dev_docs/contracts/storage"
to = "/dev_docs/contracts/syntax/storage"
to = "/developers/contracts/syntax/storage"

[[redirects]]
from = "/dev_docs/contracts/state_variables"
to = "/dev_docs/contracts/syntax/storage"
to = "/developers/contracts/syntax/storage"

[[redirects]]
from = "/dev_docs/contracts/functions"
to = "/dev_docs/contracts/syntax/functions"
to = "/developers/contracts/syntax/functions"

[[redirects]]
from = "/dev_docs/contracts/visibility"
to = "/dev_docs/contracts/syntax/visibility"
to = "/developers/contracts/syntax/visibility"

[[redirects]]
from = "/dev_docs/contracts/globals"
to = "/dev_docs/contracts/syntax/globals"
to = "/developers/contracts/syntax/globals"

[[redirects]]
from = "/dev_docs/contracts/syntax"
to = "/dev_docs/contracts/syntax/main"
to = "/developers/contracts/syntax/main"

[[redirects]]
from = "/dev_docs/contracts/contract"
to = "/dev_docs/contracts/syntax/contract"
to = "/developers/contracts/syntax/contract"

[[redirects]]
from = "/dev_docs/getting_started/cli"
to = "/dev_docs/cli/main"
to = "/developers/cli/main"

[[redirects]]
from = "/dev_docs/getting_started/noir_contracts"
to = "/dev_docs/contracts/main"
to = "/developers/contracts/main"

[[redirects]]
from = "/dev_docs/getting_started/token_contract_tutorial"
to = "/dev_docs/tutorials/writing_token_contract"
to = "/developers/tutorials/writing_token_contract"

[[redirects]]
from = "/dev_docs/getting_started/updating"
to = "/dev_docs/updating"
to = "/developers/updating"

[[redirects]]
from = "/dev_docs/sandbox/main"
to = "/dev_docs/getting_started/sandbox"
to = "/developers/getting_started/sandbox"

[[redirects]]
from = "/dev_docs/cli/updating"
to = "/dev_docs/updating"
to = "/developers/updating"

[[redirects]]
from = "/dev_docs/dapps/tutorials/main"
to = "/dev_docs/tutorials/writing_dapp/main"
to = "/developers/tutorials/writing_dapp/main"

[[redirects]]
from = "/dev_docs/dapps/tutorials/project_setup"
to = "/dev_docs/tutorials/writing_dapp/project_setup"
to = "/developers/tutorials/writing_dapp/project_setup"

[[redirects]]
from = "/dev_docs/dapps/tutorials/contract_deployment"
to = "/dev_docs/tutorials/writing_dapp/contract_deployment"
to = "/developers/tutorials/writing_dapp/contract_deployment"

[[redirects]]
from = "/dev_docs/dapps/tutorials/contract_interaction"
to = "/dev_docs/tutorials/writing_dapp/contract_interaction"
to = "/developers/tutorials/writing_dapp/contract_interaction"

[[redirects]]
from = "/dev_docs/dapps/tutorials/rpc_server"
to = "/dev_docs/tutorials/writing_dapp/rpc_server"
to = "/developers/tutorials/writing_dapp/rpc_server"

[[redirects]]
from = "/dev_docs/dapps/tutorials/testing"
to = "/dev_docs/tutorials/writing_dapp/testing"
to = "/developers/tutorials/writing_dapp/testing"

[[redirects]]
from = "/aztec/cryptography/cryptography-roadmap"
Expand Down Expand Up @@ -180,27 +180,27 @@

[[redirects]]
from = "/dev_docs/contracts/syntax/state_variables"
to = "/dev_docs/contracts/syntax/storage"
to = "/developers/contracts/syntax/storage"

[[redirects]]
from = "/dev_docs/getting_started/sandbox"
to = "/dev_docs/getting_started/quickstart"
to = "/developers/getting_started/quickstart"

[[redirects]]
from = "/dev_docs/getting_started/blank_box"
to = "/dev_docs/cli/blank_box"
to = "/developers/cli/blank_box"

[[redirects]]
from = "/dev_docs/getting_started/updating"
to = "/dev_docs/cli/updating"
to = "/developers/cli/updating"

[[redirects]]
from = "/dev_docs/sandbox_errors/main"
to = "dev_docs/debugging/sandbox-errors"
to = "developers/debugging/sandbox-errors"

[[redirects]]
from = "/dev_docs/contracts/common_errors"
to = "dev_docs/debugging/aztecnr-errors"
to = "developers/debugging/aztecnr-errors"

[[redirects]]
from = "/misc/aztec-connect-sunset"
Expand Down
4 changes: 2 additions & 2 deletions noir/aztec_macros/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ impl From<AztecMacroError> for MacroError {
fn from(err: AztecMacroError) -> Self {
match err {
AztecMacroError::AztecDepNotFound {} => MacroError {
primary_message: "Aztec dependency not found. Please add aztec as a dependency in your Cargo.toml. For more information go to https://docs.aztec.network/dev_docs/debugging/aztecnr-errors#aztec-dependency-not-found-please-add-aztec-as-a-dependency-in-your-nargotoml".to_owned(),
primary_message: "Aztec dependency not found. Please add aztec as a dependency in your Cargo.toml. For more information go to https://docs.aztec.network/developers/debugging/aztecnr-errors#aztec-dependency-not-found-please-add-aztec-as-a-dependency-in-your-nargotoml".to_owned(),
secondary_message: None,
span: None,
},
AztecMacroError::ComputeNoteHashAndNullifierNotFound { span } => MacroError {
primary_message: "compute_note_hash_and_nullifier function not found. Define it in your contract. For more information go to https://docs.aztec.network/dev_docs/debugging/aztecnr-errors#compute_note_hash_and_nullifier-function-not-found-define-it-in-your-contract".to_owned(),
primary_message: "compute_note_hash_and_nullifier function not found. Define it in your contract. For more information go to https://docs.aztec.network/developers/debugging/aztecnr-errors#compute_note_hash_and_nullifier-function-not-found-define-it-in-your-contract".to_owned(),
secondary_message: None,
span: Some(span),
},
Expand Down
4 changes: 2 additions & 2 deletions noir/docs/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Noir works differently from most ZK languages by taking a two-pronged path. Firs

:::info

Noir is backend agnostic, which means it makes no assumptions on which proving backend powers the ZK proof. Being the language that powers [Aztec Contracts](https://docs.aztec.network/dev_docs/contracts/main), it defaults to Aztec's Barretenberg proving backend.
Noir is backend agnostic, which means it makes no assumptions on which proving backend powers the ZK proof. Being the language that powers [Aztec Contracts](https://docs.aztec.network/developers/contracts/main), it defaults to Aztec's Barretenberg proving backend.

However, the ACIR output can be transformed to be compatible with other PLONK-based backends, or into a [rank-1 constraint system](https://www.rareskills.io/post/rank-1-constraint-system) suitable for backends such as Arkwork's Marlin.

Expand All @@ -48,7 +48,7 @@ Noir can be used both in complex cloud-based backends and in user's smartphones,
<TabItem value="Aztec Contracts" label="Aztec Contracts" default>
<img src={require("@site/static/img/aztec_logo.png").default} style={{display: "block", width: "50%", margin: "2rem auto"}} alt="Noir Logo" />

Aztec Contracts leverage Noir to allow for the storage and execution of private information. Writing an Aztec Contract is as easy as writing Noir, and Aztec developers can easily interact with the network storage and execution through the [Aztec.nr](https://docs.aztec.network/dev_docs/contracts/main) library.
Aztec Contracts leverage Noir to allow for the storage and execution of private information. Writing an Aztec Contract is as easy as writing Noir, and Aztec developers can easily interact with the network storage and execution through the [Aztec.nr](https://docs.aztec.network/developers/contracts/main) library.
</TabItem>
<TabItem value="Solidity Verifiers" label="Solidity Verifiers">
<img src={require("@site/static/img/solidity_verifier_ex.png").default} style={{display: "block", margin: "2rem auto"}} alt="Soliditry Verifier Example" />
Expand Down
4 changes: 2 additions & 2 deletions noir/docs/versioned_docs/version-v0.23.0/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Noir works differently from most ZK languages by taking a two-pronged path. Firs

:::info

Noir is backend agnostic, which means it makes no assumptions on which proving backend powers the ZK proof. Being the language that powers [Aztec Contracts](https://docs.aztec.network/dev_docs/contracts/main), it defaults to Aztec's Barretenberg proving backend.
Noir is backend agnostic, which means it makes no assumptions on which proving backend powers the ZK proof. Being the language that powers [Aztec Contracts](https://docs.aztec.network/developers/contracts/main), it defaults to Aztec's Barretenberg proving backend.

However, the ACIR output can be transformed to be compatible with other PLONK-based backends, or into a [rank-1 constraint system](https://www.rareskills.io/post/rank-1-constraint-system) suitable for backends such as Arkwork's Marlin.

Expand All @@ -48,7 +48,7 @@ Noir can be used both in complex cloud-based backends and in user's smartphones,
<TabItem value="Aztec Contracts" label="Aztec Contracts" default>
<img src={require("@site/static/img/aztec_logo.png").default} style={{display: "block", width: "50%", margin: "2rem auto"}} alt="Noir Logo" />

Aztec Contracts leverage Noir to allow for the storage and execution of private information. Writing an Aztec Contract is as easy as writing Noir, and Aztec developers can easily interact with the network storage and execution through the [Aztec.nr](https://docs.aztec.network/dev_docs/contracts/main) library.
Aztec Contracts leverage Noir to allow for the storage and execution of private information. Writing an Aztec Contract is as easy as writing Noir, and Aztec developers can easily interact with the network storage and execution through the [Aztec.nr](https://docs.aztec.network/developers/contracts/main) library.
</TabItem>
<TabItem value="Solidity Verifiers" label="Solidity Verifiers">
<img src={require("@site/static/img/solidity_verifier_ex.png").default} style={{display: "block", margin: "2rem auto"}} alt="Soliditry Verifier Example" />
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/accounts/src/defaults/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* The `@aztec/accounts/defaults` export provides the base class {@link DefaultAccountContract} for implementing account contracts that use the default entrypoint payload module.
*
* Read more in {@link https://docs.aztec.network/dev_docs/wallets/writing_an_account_contract | Writing an account contract}.
* Read more in {@link https://docs.aztec.network/developers/wallets/writing_an_account_contract | Writing an account contract}.
*
* @packageDocumentation
*/
Expand Down
4 changes: 2 additions & 2 deletions yarn-project/aztec.js/src/contract/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* The `contract` module provides utilities for deploying and interacting with contracts, based on a
* `Wallet` instance and a compiled artifact. Refer to the {@link account} module for how to obtain a valid
* `Wallet` instance, and to the {@link https://docs.aztec.network/dev_docs/contracts/compiling | Compiling contracts}
* `Wallet` instance, and to the {@link https://docs.aztec.network/developers/contracts/compiling | Compiling contracts}
* section of the documentation for how to generate an artifact out of your Noir source code.
*
* The {@link Contract} class is the main class in this module, and provides static methods for deploying
Expand Down Expand Up @@ -30,7 +30,7 @@
* has synchronized its changes.
*
* @remarks If you are using typescript, consider using the
* {@link https://docs.aztec.network/dev_docs/contracts/compiling#typescript-interfaces | autogenerated type-safe interfaces}
* {@link https://docs.aztec.network/developers/contracts/compiling#typescript-interfaces | autogenerated type-safe interfaces}
* for interacting with your contracts.
*
* @packageDocumentation
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/cli/src/update/update.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { updateAztecNr } from './noir.js';
import { getNewestVersion, updateAztecDeps, updateLockfile } from './npm.js';

const AZTECJS_PACKAGE = '@aztec/aztec.js';
const UPDATE_DOCS_URL = 'https://docs.aztec.network/dev_docs/updating';
const UPDATE_DOCS_URL = 'https://docs.aztec.network/developers/updating';

export async function update(
projectPath: string,
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/key-store/src/test_key_store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export class TestKeyStore implements KeyStore {
const privKey = this.#keys.get(pubKey.toString());
if (!privKey) {
throw new Error(
'Unknown account.\nSee docs for context: https://docs.aztec.network/dev_docs/debugging/aztecnr-errors#could-not-process-note-because-of-error-unknown-account-skipping-note',
'Unknown account.\nSee docs for context: https://docs.aztec.network/developers/debugging/aztecnr-errors#could-not-process-note-because-of-error-unknown-account-skipping-note',
);
}
return ConstantKeyPair.fromPrivateKey(this.curve, GrumpkinScalar.fromBuffer(privKey));
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/pxe/src/pxe_service/pxe_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ export class PXEService implements PXE {
const contract = await this.db.getContract(to);
if (!contract) {
throw new Error(
`Unknown contract ${to}: add it to PXE Service by calling server.addContracts(...).\nSee docs for context: https://docs.aztec.network/dev_docs/debugging/aztecnr-errors#unknown-contract-0x0-add-it-to-pxe-by-calling-serveraddcontracts`,
`Unknown contract ${to}: add it to PXE Service by calling server.addContracts(...).\nSee docs for context: https://docs.aztec.network/developers/debugging/aztecnr-errors#unknown-contract-0x0-add-it-to-pxe-by-calling-serveraddcontracts`,
);
}

Expand Down
2 changes: 1 addition & 1 deletion yarn-project/pxe/src/simulator_oracle/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export class SimulatorOracle implements DBOracle {
const completeAddress = await this.db.getCompleteAddress(address);
if (!completeAddress) {
throw new Error(
`No public key registered for address ${address.toString()}. Register it by calling pxe.registerRecipient(...) or pxe.registerAccount(...).\nSee docs for context: https://docs.aztec.network/dev_docs/debugging/aztecnr-errors#simulation-error-No-public-key-registered-for-address-0x0-Register-it-by-calling-pxeregisterRecipient-or-pxeregisterAccount`,
`No public key registered for address ${address.toString()}. Register it by calling pxe.registerRecipient(...) or pxe.registerAccount(...).\nSee docs for context: https://docs.aztec.network/developers/debugging/aztecnr-errors#simulation-error-No-public-key-registered-for-address-0x0-Register-it-by-calling-pxeregisterRecipient-or-pxeregisterAccount`,
);
}
return completeAddress;
Expand Down
Loading