diff --git a/docs/docs/aztec/concepts/index.md b/docs/docs/aztec/concepts/index.md index 107f24a7d20b..513f686dcada 100644 --- a/docs/docs/aztec/concepts/index.md +++ b/docs/docs/aztec/concepts/index.md @@ -51,11 +51,7 @@ Aztec allows private communications with Ethereum - ie no-one knows where the tr This is achieved through portals - these are smart contracts deployed on an EVM that are related to the Ethereum smart contract you want to interact with. -<<<<<<< HEAD:docs/docs/aztec/concepts/index.md -Learn more about portals [here](/aztec/concepts/smart_contracts/communication/cross_chain_calls). -======= Learn more about portals [here](/protocol-specs/l1-smart-contracts/index.md). ->>>>>>> origin:docs/docs/aztec/aztec/concepts/index.md ## Circuits @@ -75,9 +71,5 @@ Explore the Concepts for a deeper understanding into the components that make up ### Start coding -<<<<<<< HEAD:docs/docs/aztec/concepts/index.md Follow the [developer getting started guide](/getting_started). -======= -Follow the [developer getting started guide](/getting_started/getting_started). ->>>>>>> origin:docs/docs/aztec/aztec/concepts/index.md diff --git a/docs/docs/aztec/concepts/smart_contracts/communication/index.md b/docs/docs/aztec/concepts/smart_contracts/communication/index.md index 4172cdea96d0..2a6b7a8edf53 100644 --- a/docs/docs/aztec/concepts/smart_contracts/communication/index.md +++ b/docs/docs/aztec/concepts/smart_contracts/communication/index.md @@ -9,4 +9,4 @@ See [Private \<--\> Public execution](./public_private_calls.md) for information ## Cross-chain communication -Read the protocol specification about Cross-chain communication between Aztec and Ethereum [here](../../../../../protocol-specs/l1-smart-contracts/index.md). +Read the protocol specification about Cross-chain communication between Aztec and Ethereum [here](/protocol-specs/l1-smart-contracts/index.md). diff --git a/docs/docs/guides/guides/smart_contracts/writing_contracts/portals/index.md b/docs/docs/guides/guides/smart_contracts/writing_contracts/portals/index.md deleted file mode 100644 index f861c47664a5..000000000000 --- a/docs/docs/guides/guides/smart_contracts/writing_contracts/portals/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Portals ---- - -A portal is a point of contact between L1 and a contract on Aztec. For applications such as token bridges, this is the point where the tokens are held on L1 while used in L2. - -As outlined in [Communication](../../../../../protocol-specs/l1-smart-contracts/index.md), an Aztec L2 contract does not have to be linked to a portal contract, but can specify an intended portal in storage. Note, that a portal doesn't actually need to be a contract, it could be any address on L1. diff --git a/docs/docs/guides/smart_contracts/writing_contracts/index.md b/docs/docs/guides/smart_contracts/writing_contracts/index.md new file mode 100644 index 000000000000..2c857ff0af33 --- /dev/null +++ b/docs/docs/guides/smart_contracts/writing_contracts/index.md @@ -0,0 +1,7 @@ +--- +title: Portals +--- + +A portal is a point of contact between L1 and a contract on Aztec. For applications such as token bridges, this is the point where the tokens are held on L1 while used in L2. + +As outlined in [Communication](/protocol-specs/l1-smart-contracts/index.md), an Aztec L2 contract does not have to be linked to a portal contract, but can specify an intended portal in storage. Note, that a portal doesn't actually need to be a contract, it could be any address on L1. diff --git a/docs/docs/guides/smart_contracts/writing_contracts/portals/communicate_with_portal.md b/docs/docs/guides/smart_contracts/writing_contracts/portals/communicate_with_portal.md index d882333dd753..b5e8ab061e87 100644 --- a/docs/docs/guides/smart_contracts/writing_contracts/portals/communicate_with_portal.md +++ b/docs/docs/guides/smart_contracts/writing_contracts/portals/communicate_with_portal.md @@ -42,7 +42,7 @@ Note that while the `secret` and the `content` are both hashed, they are actuall ### Token bridge example -Computing the `content` must currently be done manually, as we are still adding a number of bytes utilities. A good example exists within the [Token bridge example](../../../../../tutorials/tutorials/contract_tutorials/advanced/token_bridge/minting_on_aztec.md#consume-the-l1-message). +Computing the `content` must currently be done manually, as we are still adding a number of bytes utilities. A good example exists within the [Token bridge example](/tutorials/contract_tutorials/advanced/token_bridge/minting_on_aztec.md#consume-the-l1-message). #include_code claim_public /noir-projects/noir-contracts/contracts/token_bridge_contract/src/main.nr rust diff --git a/docs/docs/reference/sandbox_reference/sandbox-reference.md b/docs/docs/reference/sandbox_reference/sandbox-reference.md index 412a11a40366..2ecce9b8a9b4 100644 --- a/docs/docs/reference/sandbox_reference/sandbox-reference.md +++ b/docs/docs/reference/sandbox_reference/sandbox-reference.md @@ -4,13 +4,13 @@ title: Sandbox Reference :::tip -For a quick start, follow the [guide](/getting_started) to install the sandbox. +For a quick start, follow the [guide](/getting_started.md) to install the sandbox. ::: ## Manual Install -You can manually install the sandbox via the underlying script used in the [Aztec Boxes](getting_started/index.md#run-the-npx-script). +You can manually install the sandbox via the underlying script used in the [Aztec Boxes](getting_started.md#run-the-npx-script). ### Prerequisites diff --git a/docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md b/docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md index 75bcf5a545d0..3331911f850f 100644 --- a/docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md +++ b/docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md @@ -35,11 +35,7 @@ Aztec has the following core smart contracts on L1 that we need to know about: - `Outbox.sol` - a mailbox to the rollup for L2 to L1 messages (e.g. withdrawing tokens). Aztec contracts emit these messages and the sequencer adds these to the outbox. Portals then consume these messages. - `Registry.sol` - just like L1, we assume there will be various versions of Aztec (due to upgrades, forks etc). In such a case messages must not be replayable in other Aztec “domains”. A portal must decide which version/ID of Aztec the message is for. The registry stores the rollup, inbox and outbox address for each version of Aztec deployments, so the portal can find out the address of the mailbox it wants to talk to -<<<<<<< HEAD:docs/docs/tutorials/contract_tutorials/advanced/token_bridge/index.md -For more information, read [cross-chain calls](/aztec/concepts/smart_contracts/communication/cross_chain_calls). -======= For more information, read [cross-chain calls](/protocol-specs/l1-smart-contracts/index.md). ->>>>>>> origin:docs/docs/tutorials/tutorials/contract_tutorials/advanced/token_bridge/index.md ## Building a Token Bridge with Portals diff --git a/docs/scripts/move_processed.sh b/docs/scripts/move_processed.sh index a40d11169256..8280970d1a48 100755 --- a/docs/scripts/move_processed.sh +++ b/docs/scripts/move_processed.sh @@ -1,3 +1,3 @@ #!/usr/bin/env bash - +echo "label: \"AztecJS\"" > ./docs/reference/aztecjs/_category_.yml mv ./docs/reference/aztecjs ./processed-docs/reference/aztecjs