From cf4a7f1dd28346dfb98ecc1fcbb816f1ecbac3f2 Mon Sep 17 00:00:00 2001 From: Megan Skye <58894568+meganskye@users.noreply.github.com> Date: Fri, 18 Aug 2023 17:00:27 -0700 Subject: [PATCH] Restore links removed temporarily during docs-revamp merge (#414) * Update xcm-transactions.md * restore missing links, and minor polishing * Delete xcm-transactions.md * restore missing links, and minor polishing * fix markdown links excluded those referencing unknown locations with (INSERT_LINK) * remove reference folder paths * Revert "remove reference folder paths" This reverts commit 20750577d59fc4a72b014e3a4df3364fba7fe41a. --- docs/build/EVM/evm-debug-api.md | 2 +- docs/build/EVM/precompiles/xc20.md | 2 +- docs/build/EVM/precompiles/xcm.md | 6 +++--- docs/build/Introduction/create_account.md | 2 +- .../leverage_parachains/interact_with_xc20.md | 2 +- docs/build/environment/endpoints.md | 2 +- docs/build/environment/zombienet-testing.md | 2 +- docs/build/index.md | 4 ++-- docs/build/integrations/indexers/subsquid.md | 2 +- docs/build/integrations/indexers/thegraph.md | 2 +- docs/build/integrations/node-providers/index.md | 5 +++-- .../build/integrations/wallets/ledger/ledger-native.md | 2 +- docs/build/nodes/archive-node/binary.md | 8 ++++---- docs/build/nodes/archive-node/docker.md | 10 +++++----- docs/build/nodes/archive-node/index.md | 7 ++++--- docs/build/nodes/collator/learn.md | 2 +- docs/build/nodes/collator/requirements.md | 2 +- .../nodes/collator/secure_setup_guide/building_node.md | 4 ++-- docs/build/nodes/collator/spinup_collator.md | 2 +- docs/build/nodes/evm-tracing-node.md | 10 +++++----- docs/build/nodes/full-node.md | 2 +- docs/build/nodes/node-maintenance.md | 2 +- docs/build/wasm/contract_environment/explorers.md | 1 + docs/getting-started.md | 10 +++++----- docs/learn/ecosystem/polkadot.md | 1 - docs/learn/xcm/faq.md | 8 ++++---- docs/learn/xcm/integration/add-to-portal.md | 2 +- docs/use/Manage assets/manage-xc20-with-metamask.md | 4 ++-- docs/use/Manage assets/transfer-tokens.md | 8 ++++---- docs/use/Manage assets/xcm-transactions.md | 4 ++-- docs/use/user-guides/create-wallet.md | 0 docusaurus.config.js | 2 +- src/pages/index.tsx | 2 +- 33 files changed, 63 insertions(+), 61 deletions(-) create mode 100644 docs/use/user-guides/create-wallet.md diff --git a/docs/build/EVM/evm-debug-api.md b/docs/build/EVM/evm-debug-api.md index 6989318ff1c2..d8c2ed46a962 100644 --- a/docs/build/EVM/evm-debug-api.md +++ b/docs/build/EVM/evm-debug-api.md @@ -53,7 +53,7 @@ Spinning up a debug or tracing node is similar to running a full node. However, :::info -EVM tracing node installation manual available on this page (INSERT_LINK). +EVM tracing node installation manual available on [this page](/docs/build/nodes/evm-tracing-node). ::: diff --git a/docs/build/EVM/precompiles/xc20.md b/docs/build/EVM/precompiles/xc20.md index e37109b1915f..c5e5290e81fc 100644 --- a/docs/build/EVM/precompiles/xc20.md +++ b/docs/build/EVM/precompiles/xc20.md @@ -2,7 +2,7 @@ XC20 standard, created by the Moonbeam team, ensures compatibility between the EVM and Substrate framework that powers Polkadot via precompiles — special built-in smart contracts made to look like ERC20s. Calling functions on an XC20 invokes underlying Substrate functionality, which could be instructions to move tokens to another chain, or send them to another local address. This compatibility layer connects the world of EVM and smart contracts to advanced Substrate-based interoperability scenarios. -For XC20 overview see the following page (INSERT_LINK). +For XC20 overview see the following page (/docs/learn/xcm/building-with-xcm/create-xc20-assets). # See also diff --git a/docs/build/EVM/precompiles/xcm.md b/docs/build/EVM/precompiles/xcm.md index dcf67430df1c..76ed4f98c7ef 100644 --- a/docs/build/EVM/precompiles/xcm.md +++ b/docs/build/EVM/precompiles/xcm.md @@ -4,6 +4,6 @@ The XCM Precompile provides the following functions to handle specific XCM opera | Function | Description | | -------- | -------- | -| `assets_withdraw` (INSERT_LINK) | Withdraw previously transferred assets | -| `assets_reserve_transfer` (INSERT_LINK) | Transfer assets to a remote chain | -| `remote_transact` (INSERT_LINK) | Execute a transaction on a remote chain | +| `assets_withdraw` (/docs/learn/xcm/building-with-xcm/xc-assets-withdraw) | Withdraw previously transferred assets | +| `assets_reserve_transfer` (/docs/learn/xcm/building-with-xcm/xc-reserve-transfer/) | Transfer assets to a remote chain | +| `remote_transact` (/docs/learn/xcm/building-with-xcm/xc-remote-transact/) | Execute a transaction on a remote chain | diff --git a/docs/build/Introduction/create_account.md b/docs/build/Introduction/create_account.md index 68e62930c7a4..f0eb0b7f4408 100644 --- a/docs/build/Introduction/create_account.md +++ b/docs/build/Introduction/create_account.md @@ -3,7 +3,7 @@ sidebar_position: 3 --- # Create Account -If you never created a native Astar account, please follow the instructions in User Guide (INSERT_LINK). +If you never created a native Astar account, please follow the instructions in the [User Guide](/docs/use/user-guides/create-wallet). If you are building EVM smart contracts you will need Metamask. Watch this short video to learn how. diff --git a/docs/build/builder-guides/leverage_parachains/interact_with_xc20.md b/docs/build/builder-guides/leverage_parachains/interact_with_xc20.md index 8dfef240b1da..5e7ea7ee7949 100644 --- a/docs/build/builder-guides/leverage_parachains/interact_with_xc20.md +++ b/docs/build/builder-guides/leverage_parachains/interact_with_xc20.md @@ -124,7 +124,7 @@ In order to confirm receiving the asset on EVM, we need to add the specific asse - Convert the `asset ID` from hexadecimal to decimal - Add the prefix of `0xffffffff` - for example, our Cookbook Token, CKT, has `asset ID` of `229`. Following the step above, we will have the converted address of `0xffffffff000000000000000000000000000000E5`. -- More information can be found in the following guide: Send XC20 Assets to EVM (INSERT_LINK) +- More information can be found in the following guide: [Send XC20 Assets to EVM](/docs/build/builder-guides/leverage_parachains/interact_with_xc20.md#send-the-asset-to-evm) ![Untitled](mintable-xc20-cookbook/Untitled%207.png) diff --git a/docs/build/environment/endpoints.md b/docs/build/environment/endpoints.md index 6039a62ef9c7..e2f4b4a30036 100644 --- a/docs/build/environment/endpoints.md +++ b/docs/build/environment/endpoints.md @@ -22,7 +22,7 @@ The free endpoints below are dedicated to end users, they can be used to interac They limit the rate of API calls, so they are not suitable for high demand, such as a dApp UI constantly scraping blockchain data or an indexer. ::: :::tip -To meet the demands of a production dApp you can run an archive node (INSERT_LINK) **or** get your own API key from one of our infra partners (INSERT_LINK). +To meet the demands of a production dApp you can run an [archive node](/docs/build/nodes/archive-node/) **or** get your own API key from one of our [infrastructure partners](/docs/build/integrations/node-providers). ::: diff --git a/docs/build/environment/zombienet-testing.md b/docs/build/environment/zombienet-testing.md index 8b79e4d691c8..df47a7491bbd 100644 --- a/docs/build/environment/zombienet-testing.md +++ b/docs/build/environment/zombienet-testing.md @@ -90,7 +90,7 @@ For all steps, encoded call data will be provided to simplify the process for th After completing the previous steps, cross-chain SDN and SBY wrappers are configured as payable and sufficient assets. The following steps will explain how to execute a cross-chain remote call. `Alice` will send an instruction from `Shiden` to execute `System::remark_with_event` on `Shibuya`. -`Alice` isn't able to directly control `Alice` on the destination chain, instead a new account will be derived. More information can be found here (INSERT_LINK). +`Alice` isn't able to directly control `Alice` on the destination chain, instead a new account will be derived. More information can be found [here](/docs/learn/xcm/building-with-xcm/xc-remote-transact.md#derived-remote-accounts). 1. Calculate `Alice's` derived account on `Shibuya` when sending instructions from `Shiden`. ``` diff --git a/docs/build/index.md b/docs/build/index.md index a00857b213b0..f296529fb5c1 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -12,10 +12,10 @@ The shared security of Polkadot, coupled with Astar XVM, allows developers to de Wasm smart contracts empower developers, and bridge the gap between blockchain and traditional software development, allowing them to build complex dApps with tools and languages they already know. Wasm provides direct access to the runtime in a number of ways, so developers can build dApps that aren't possible on the Ethereum Virtual Machine. Any programming language that compiles to Wasm may eventually be supported, making Astar network a secure and versatile environment for deployment of highly-optimized smart contracts. See the [Wasm chapter](/docs/build/wasm) for more information. ## EVM smart contracts -Solidity developers will feel right at home building on Astar EVM, as it provides an equivalent environment, and simultaneously allows them to fragment smart contracts and offload logic selectively to the Wasm Virtual Machine for applications that have different operating requirements. See the [EVM chapter.](/docs/build/evm) for more information. +Solidity developers will feel right at home building on Astar EVM, as it provides an equivalent environment, and simultaneously allows them to fragment smart contracts and offload logic selectively to the Wasm Virtual Machine for applications that have different operating requirements. See the [EVM chapter](/docs/build/evm) for more information. ## Build2Earn -Astar network's innovative Build2Earn program allows developers to earn a basic income while they build out their products and communities. Users are able to support projects by staking on them, which adds to the passive income developers earn. Build2Earn encourages projects to stand out, and provide value directly to the end-users. See the dApp staking (INSERT_LINK) section for more information. +Astar network's innovative Build2Earn program allows developers to earn a basic income while they build out their products and communities. Users are able to support projects by staking on them, which adds to the passive income developers earn. Build2Earn encourages projects to stand out, and provide value directly to the end-users. See the [dApp staking section](/docs/build/dapp-staking/) for more information. ## XVM - The cross virtual machine The Cross Virtual Machine allows developers to call smart contracts from one VM to another (e.g. Wasm to EVM), and `XVM`, the innovative protocol that makes creation of these hybrid cross-VM dApps possible, is *only* available on Astar network. diff --git a/docs/build/integrations/indexers/subsquid.md b/docs/build/integrations/indexers/subsquid.md index 3e3d87e80fb2..6a2c84d5577e 100644 --- a/docs/build/integrations/indexers/subsquid.md +++ b/docs/build/integrations/indexers/subsquid.md @@ -4,7 +4,7 @@ sidebar_position: 1 # Subsquid -[Subsquid](https://subsquid.io) is an indexing framework supporting both Substrate (INSERT_LINK) and EVM (INSERT_LINK)-based chains. It is [extremely flexible and offers high syncing speeds](https://docs.subsquid.io/migrate/subsquid-vs-thegraph/). Subsquid comes with a set of code generation tools that make ready-to-use, customizable indexer projects ("squids") out of contracts' ABIs. WASM/ink! and EVM/Solidity contracts are supported. Once scraped, the contract data can be served over a GraphQL API or stored as a dataset. +[Subsquid](https://subsquid.io) is an indexing framework supporting both [Substrate](/docs/build/wasm) and [EVM](/docs/build/EVM)-based chains. It is extremely flexible and offers [high syncing speeds](https://docs.subsquid.io/migrate/subsquid-vs-thegraph/). Subsquid comes with a set of code generation tools that make ready-to-use, customizable indexer projects ("squids") out of contracts' ABIs. WASM/ink! and EVM/Solidity contracts are supported. Once scraped, the contract data can be served over a GraphQL API or stored as a dataset. Squids can run either locally or in a Subsquid-provided a cloud service called Aquarium. The service has and will always have a free tier. For more demanding applications it offers a premium subscription. diff --git a/docs/build/integrations/indexers/thegraph.md b/docs/build/integrations/indexers/thegraph.md index 2ec93b2925f9..6c2a7574ec66 100644 --- a/docs/build/integrations/indexers/thegraph.md +++ b/docs/build/integrations/indexers/thegraph.md @@ -22,7 +22,7 @@ In this guide, we will demonstrate how to run an Astar node for getting more ins ## Running a Graph Node -After successfully running an [RPC node](https://docs.astar.network/docs/nodes/archive-node/), the Graph node will need to be installed and configured to connect to a separate computer. If you are running a self-signed RPC node, you will need to set up an extra environment variable for allowance. +After successfully running an [RPC node](https://docs.astar.network/docs/build/nodes/archive-node/), the Graph node will need to be installed and configured to connect to a separate computer. If you are running a self-signed RPC node, you will need to set up an extra environment variable for allowance. The first step is to clone the [Graph Node repository](https://github.com/graphprotocol/graph-node/): diff --git a/docs/build/integrations/node-providers/index.md b/docs/build/integrations/node-providers/index.md index 7ef5a02989e3..18927d253382 100644 --- a/docs/build/integrations/node-providers/index.md +++ b/docs/build/integrations/node-providers/index.md @@ -1,9 +1,10 @@ # Node Providers -The free endpoints mentioned in the [Build Environment section](/docs/build/environment/endpoints.md) are rate limited and designed for end users to be able to interact with dApps, or deploy/call smart contracts. They are not suitable for usage by dApp UIs that scrape blockchain data continuously, or indexers (like the Graph). +The free endpoints mentioned in the [Build Environment section](/docs/build/environment/endpoints) are rate limited and designed for end users to be able to interact with dApps, or deploy/call smart contracts. They are not suitable for usage by dApp UIs that scrape blockchain data continuously, or indexers (like the Graph). -If you are an active developer you should consider creating your own endpoint, and it is mandatory to do so for production deployments. Refer to how run an archive node (INSERT_LINK) for more information, or obtain an API key from one of our infrastructure providers, listed below: +If you are an active developer you should consider creating your own endpoint, and it is mandatory to do so for production deployments. Refer to how run an [archive node](/docs/nodes +/archive-node/) for more information, or obtain an API key from one of our infrastructure providers, listed below: ```mdx-code-block diff --git a/docs/build/integrations/wallets/ledger/ledger-native.md b/docs/build/integrations/wallets/ledger/ledger-native.md index 09f5f96e6c96..1c86a69e95ac 100644 --- a/docs/build/integrations/wallets/ledger/ledger-native.md +++ b/docs/build/integrations/wallets/ledger/ledger-native.md @@ -86,7 +86,7 @@ Ledger NanoS users should install the Astar XL version of the app, shown in the -For detailed information about dApp staking or how to stake on the EVM side of Astar Portal using a Ledger device, please refer to the Astar documentation (INSERT_LINK) or [Ledger EVM staking guide](./ledger-evm.md) +For detailed information about dApp staking or how to stake on the EVM side of Astar Portal using a Ledger device, please refer to the [Astar official documentation](/docs/build/dapp-staking/for-stakers/) or [Ledger EVM staking guide](./ledger-evm.md) :::tip If you receive a **Ledger error: Failed to execute 'claimInterface' on 'USBDevice': Unable to claim interface** message during the dApp staking claim process, ensure you are performing the operation using a Chromium-based browser such as Chrome or Brave, and the Ledger device connection method is WebHID, as outlined in the previous step. diff --git a/docs/build/nodes/archive-node/binary.md b/docs/build/nodes/archive-node/binary.md index c1baaae98279..934871b4ea3e 100644 --- a/docs/build/nodes/archive-node/binary.md +++ b/docs/build/nodes/archive-node/binary.md @@ -184,11 +184,11 @@ curl -H "Content-Type: application/json" --data '{ "jsonrpc":"2.0", "method":"sy ## Next steps -For any usage, wait for the chain to be fully sync by checking the node log (INSERT_LINK). +For any usage, wait for the chain to be fully sync by checking the [node log](/docs/build/nodes/archive-node/binary#get-node-logs). It all depends on what you plan to do with your archive node. -- In most cases, you will want to access node from outside. In this case, nginx server (INSERT_LINK) is the recommended option. +- In most cases, you will want to access node from outside. In this case, [nginx server](/docs/build/nodes/archive-node/nginx) is the recommended option. - If you run your dApp on the same server as the node, then you can access it directly with the `localhost` address. This setup is recommended for testing purpose only. - If you run the node locally for testing purpose, you can switch the network in [Polkadot.js portal](https://polkadot.js.org/apps) and explore the chain: @@ -214,7 +214,7 @@ To access data from indexers (e.g. The Graph) or Oracles (e.g. Chainlink), you n ### Upgrade node -When an upgrade is necessary, node operators are be notified in our Discord (INSERT_LINK) and Element (INSERT_LINK) group. +When an upgrade is necessary, node operators are be notified in our Discord and Element group. Download the [latest release](https://github.com/AstarNetwork/Astar/releases/latest) from Github @@ -243,5 +243,5 @@ sudo systemctl start astar.service ### Snapshot -Please refer to the **snapshot page** (INSERT_LINK). +Please refer to the [**snapshot page**](/docs/build/nodes/snapshots). ::: diff --git a/docs/build/nodes/archive-node/docker.md b/docs/build/nodes/archive-node/docker.md index 7e6195c845bb..76d994687f16 100644 --- a/docs/build/nodes/archive-node/docker.md +++ b/docs/build/nodes/archive-node/docker.md @@ -116,10 +116,10 @@ curl -H "Content-Type: application/json" --data '{ "jsonrpc":"2.0", "method":"sy ## Next steps -In any case, wait for the chain to be fully synchronized by checking the node log (INSERT_LINK). +In any case, wait for the chain to be fully synchronized by checking the [node log](/docs/build/nodes/archive-node/binary#get-node-logs). How the archive node will be used will largely determine what steps to follow next: -- If accessing the node publicly, running an nginx server (INSERT_LINK) is the recommended option. +- If accessing the node publicly, running an [nginx server](/docs/build/nodes/archive-node/nginx) is the recommended option. - If the dApp is running on the same server as the node, then it can be accessed directly with the `localhost` address. This setup is recommended for testing purposes only. - If running the node locally for testing purposes, switch networks in [Polkadot.js portal](https://polkadot.js.org/apps) to explore the chain: @@ -151,7 +151,7 @@ To access data from indexers (like The Graph) or Oracles (like Chainlink), add t ## Upgrade node -When a node upgrade is necessary, node operators are notified with instructions in the [Astar Dev Announcement Telegram](https://t.me/+cL4tGZiFAsJhMGJk), Astar Discord (INSERT_LINK), and [Astar Node Upgrade Element channel](https://matrix.to/#/#shiden-runtime-ann:matrix.org). Join and follow any of these channels to receive news about node updates and node upgrades. +When a node upgrade is necessary, node operators are notified with instructions in the [Astar Dev Announcement Telegram](https://t.me/+cL4tGZiFAsJhMGJk), [Astar Discord](https://discord.gg/Z3nC9U4), and [Astar Node Upgrade Element channel](https://matrix.to/#/#shiden-runtime-ann:matrix.org). Join and follow any of these channels to receive news about node updates and node upgrades. To upgrade to the latest node version, stop and remove the actual container: @@ -177,9 +177,9 @@ sudo rm -R /var/lib/astar/* where `CHAIN` is `astar`, `shiden`, or `shibuya`. -Then start a new container by following the instructions under the Start Docker node (INSERT_LINK) section. +Then start a new container by following the instructions under the [Start Docker node](/docs/build/nodes/archive-node/docker#start-docker-node) section. ### Snapshot -Please refer to **snapshot page** (INSERT_LINK). +Please refer to [**snapshot page**](/docs/build/nodes/snapshots/). ::: diff --git a/docs/build/nodes/archive-node/index.md b/docs/build/nodes/archive-node/index.md index 6485c56b7e18..8f5fac0df3fd 100644 --- a/docs/build/nodes/archive-node/index.md +++ b/docs/build/nodes/archive-node/index.md @@ -6,7 +6,8 @@ import TabItem from '@theme/TabItem'; ## Overview An **archive node** stores the history of past blocks. Most of times, an archive node is used as **RPC endpoint**. -RPC plays a vital role on our network: it connects users and dApps to the blockchain through WebSocket and HTTP endpoints. For example, our public endpoints (INSERT_LINK) run archive nodes for anyone to quickly connect to Astar chains. +RPC plays a vital role on our network: it connects users and dApps to the blockchain through WebSocket and HTTP endpoints. For example, our [public endpoints](/docs/build/environment +/endpoints) run archive nodes for anyone to quickly connect to Astar chains. **DApp projects** need to run their own RPC node as archive to the retrieve necessary blockchain data and not to rely on public infrastructure. Public endpoints respond slower because of the large amount of users connected and are rate limited. @@ -82,6 +83,6 @@ For all types of nodes, ports `30333` and `30334` need to be opened for incoming There are 2 different ways to run an Astar node: -Using Binary (INSERT_LINK) - run the node from binary file and set it up as systemd service +Using [Binary](/docs/build/nodes/archive-node/binary) - run the node from binary file and set it up as systemd service -Using Docker (INSERT_LINK) - run the node within a Docker container +Using [Docker](/docs/build/nodes/archive-node/docker) - run the node within a Docker container diff --git a/docs/build/nodes/collator/learn.md b/docs/build/nodes/collator/learn.md index c9d8c6a814b8..86431308aa4f 100644 --- a/docs/build/nodes/collator/learn.md +++ b/docs/build/nodes/collator/learn.md @@ -43,7 +43,7 @@ A collator (block producer) is rewarded a fixed amount for each block produced. ## Collator election mechanism ### Election process -To join the election process you must register for a collator and bond tokens, see [Collator Requirements](https://docs.astar.network/docs/nodes/collator/requirements) for details. When your node fits the parameters and checks all the boxes to become a collator, it will be added to the chain. **Note: if your collator doesn’t produce blocks during two sessions (2h) it will be kicked out.** +To join the election process you must register for a collator and bond tokens, see [Collator Requirements](https://docs.astar.network/docs/build/nodes/collator/requirements) for details. When your node fits the parameters and checks all the boxes to become a collator, it will be added to the chain. **Note: if your collator doesn’t produce blocks during two sessions (2h) it will be kicked out.** --- diff --git a/docs/build/nodes/collator/requirements.md b/docs/build/nodes/collator/requirements.md index 376978fc8295..4e5e9cb5593d 100644 --- a/docs/build/nodes/collator/requirements.md +++ b/docs/build/nodes/collator/requirements.md @@ -100,5 +100,5 @@ To run a collator, it is absolutely necessary to use a **CPU of minimum 4 Ghz pe :::tip Shibuya is the perfect network to test out your knowledge about running nodes in the Astar ecosystem. To join the collator set on Shibuya you need to apply for a 32k SBY fund. -If you never operated a collator node, we strongly encourage you to spin up a **Shibuya collator** node to start before thinking about mainnet. A perfect start is our secure setup guide (INSERT_LINK). +If you never operated a collator node, we strongly encourage you to spin up a **Shibuya collator** node to start before thinking about mainnet. A perfect start is our [secure setup guide](/docs/build/nodes/collator/secure_setup_guide/). ::: diff --git a/docs/build/nodes/collator/secure_setup_guide/building_node.md b/docs/build/nodes/collator/secure_setup_guide/building_node.md index f5da5bf39536..d5b714acc9c4 100644 --- a/docs/build/nodes/collator/secure_setup_guide/building_node.md +++ b/docs/build/nodes/collator/secure_setup_guide/building_node.md @@ -283,7 +283,7 @@ sudo systemctl enable astar.service ### Snapshot -Please refer to **snapshot page** (INSERT_LINK). +Please refer to the [**snapshot page**](/docs/build/nodes/snapshots). ## Finalizing @@ -296,5 +296,5 @@ To finalize your collator you need to: * Verify your identity * Bond tokens -this part is covered in chapter Spin up a Collator (INSERT_LINK) +this part is covered in chapter [Spin up a Collator](/docs/build/nodes/collator/spinup_collator) diff --git a/docs/build/nodes/collator/spinup_collator.md b/docs/build/nodes/collator/spinup_collator.md index 2b7f0fd967c6..8150bf297d71 100644 --- a/docs/build/nodes/collator/spinup_collator.md +++ b/docs/build/nodes/collator/spinup_collator.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; # Spin up a Collator :::caution -Collators are responsible for the network stability, it is very important to be able to react at any time of the day or night in case of trouble. We strongly encourage collators to set up a monitoring and alerting system, learn more about this from our secure setup guide (INSERT_LINK). +Collators are responsible for the network stability, it is very important to be able to react at any time of the day or night in case of trouble. We strongly encourage collators to set up a monitoring and alerting system, learn more about this from our [secure setup guide](/docs/build/nodes/collator/secure_setup_guide/). ::: ### Service Parameters diff --git a/docs/build/nodes/evm-tracing-node.md b/docs/build/nodes/evm-tracing-node.md index 758677932925..7969c3128ad7 100644 --- a/docs/build/nodes/evm-tracing-node.md +++ b/docs/build/nodes/evm-tracing-node.md @@ -9,26 +9,26 @@ import TabItem from '@theme/TabItem'; ## Overview -Running a tracing node on an Astar chain allows you to debug EVM transactions and have enhanced access to transaction pool using EVM debug RPC (INSERT_LINK). +Running a tracing node on an Astar chain allows you to debug EVM transactions and have enhanced access to transaction pool using EVM debug RPC (INSERT_LINK also see link below). ## Requirements -Requirements for running any node are similar to what we recommend for archive node. Read more about this here (INSERT_LINK). +Requirements for running a tracing node are similar to what we recommend for an archive node. Read more about this [here](/docs/build/nodes/archive-node/). ## Node launch -Tracing node setup in general is equal to Archive Node setup (INSERT_LINK). Except binary location and additional launch flags. +Tracing node setup in general is similar to the [Archive Node setup](/docs/build/nodes/archive-node/), except for the location of the binary and some additional launch flags. :::info -EVM tracing node binary is different because includes additional tracing features. You can easily build it from source code using `cargo build --release --features evm-tracing` command or download the `evm-tracing-artifacts` from [latest release](https://github.com/AstarNetwork/Astar/releases/latest), executable EVM tracing binary is included in the compressed file `evm-tracing-artifacts.tar.gz`. +An EVM tracing node binary is different because it includes additional tracing features. You can easily build it from source using `cargo build --release --features evm-tracing` command or download the `evm-tracing-artifacts` from [latest release](https://github.com/AstarNetwork/Astar/releases/latest), an executable EVM tracing binary is included in the compressed file `evm-tracing-artifacts.tar.gz`. ::: :::important -EVM RPC calls are disabled by default, and require the `--enable-evm-rpc` additional flag to be enabled. Please refer to this page (INSERT_LINK) for more info. +EVM RPC calls are disabled by default, and require the `--enable-evm-rpc` flag to be enabled. Please refer to this page (INSERT_LINK) for more info. ::: diff --git a/docs/build/nodes/full-node.md b/docs/build/nodes/full-node.md index deded8b2608f..fc6d33d32ab3 100644 --- a/docs/build/nodes/full-node.md +++ b/docs/build/nodes/full-node.md @@ -20,7 +20,7 @@ If your node need to provide old historical blocks' data, please consider to use ## Requirements -Requirements for running any node are similar to what we recommend for archive node. Read more about this here (INSERT_LINK). +Requirements for running any node are similar to what we recommend for archive node. Read more about this [here](/docs/build/nodes/archive-node/). Note that Full node requires less disk space. Hard Disk requirement for Archive node is not applied to Full nodes. To set a full node, you need to specify the number of blocks to be pruned: diff --git a/docs/build/nodes/node-maintenance.md b/docs/build/nodes/node-maintenance.md index b49344b0aa9e..f6131c182ed9 100644 --- a/docs/build/nodes/node-maintenance.md +++ b/docs/build/nodes/node-maintenance.md @@ -90,5 +90,5 @@ sudo systemctl start {NETWORK}.service ## Snapshot -Please refer to **snapshot page** (INSERT_LINK). +Please refer to **snapshot page**(/docs/build/nodes/snapshots). ::: diff --git a/docs/build/wasm/contract_environment/explorers.md b/docs/build/wasm/contract_environment/explorers.md index 06af21d76107..6cd23201edc8 100644 --- a/docs/build/wasm/contract_environment/explorers.md +++ b/docs/build/wasm/contract_environment/explorers.md @@ -37,3 +37,4 @@ Block explorers are the Google for searching data on a blockchain. They give dev +Visit the Subscan [tutorial page](/docs/build/integrations/indexers/subscan) for more information. diff --git a/docs/getting-started.md b/docs/getting-started.md index f9b98f96a2c9..28b683885a62 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -10,10 +10,10 @@ Astar is the largest smart contract platform in the Polkadot ecosystem, supporti - [**Build**](/docs/build) gives you the resources you need to get started with building. testing, deploying, and interacting with smart contracts on the network. -- [**EVM**](/docs/build/evm) dives deeper into EVM on Astar and explains how EVM contracts can interact with other non-EVM modules through precompiles (INSERT_LINK). -- [**WASM**](/docs/build/wasm) provides an overview of the Wasm stack on Astar (INSERT_LINK), Wasm contract frameworks (INSERT_LINK), and Swanky Suite (INSERT_LINK). -- **Nodes** (INSERT_LINK) explains how to run full nodes, collators, indexers, and everything you need to know related to infrastructure. -- **XCM** (INSERT_LINK) explains how XCM is used in Astar and how developers can use it to interact with the rest of the Polkadot network. -- **Integrations** (INSERT_LINK) provide relevant information about the wallets, indexers, and oracles that are integrated with the network. +- [**EVM**](/docs/build/evm) dives deeper into EVM on Astar and explains how EVM contracts can interact with other non-EVM modules through [precompiles](https://docs.astar.network/docs/build/EVM/precompiles/). +- [**Wasm**](/docs/build/wasm) provides an overview of the [Wasm stack](https://docs.astar.network/docs/build/wasm/smart-contract-wasm) on Astar, [Wasm contract frameworks](/docs/build/wasm/dsls), and [Swanky Suite](/docs/build/wasm/swanky-suite/). +- **Nodes**(/docs/build/nodes) explains how to run full nodes, collators, indexers, and everything you need to know related to infrastructure. +- **XCM**(/docs/learn/xcm) explains how XCM is used in Astar and also how developers can use it to interact with the rest of the Polkadot network. +- **Integrations**(/docs/build/integrations/) provide relevant information about the wallets, indexers, and oracles that are integrated with the network. [cbridge]: https://cbridge.celer.network/#/transfer diff --git a/docs/learn/ecosystem/polkadot.md b/docs/learn/ecosystem/polkadot.md index a8642d76b8c7..123afce1b023 100644 --- a/docs/learn/ecosystem/polkadot.md +++ b/docs/learn/ecosystem/polkadot.md @@ -14,7 +14,6 @@ Polkadot consists of two parts: Relaychain and Parachain. - Relaychain: This is the core of Polkadot which is responsible for network security, consensus, and cross-chain interoperability. - Parachain: These are sovereign blockchains with custom tokens and optimized functionality for specific use cases. Parachain connection to Relaychain is priced on a pay-as-you-go basis or a continuous connectivity lease. -Astar Network is built on Parity Substrate making it one of the first SCALABLE smart contract Polkadot Parachains. Astar Network is built on Parity Substrate making it one of the first SCALABLE smart contract Polkadot Parachains. diff --git a/docs/learn/xcm/faq.md b/docs/learn/xcm/faq.md index 561e51d1a299..2c58f797af57 100644 --- a/docs/learn/xcm/faq.md +++ b/docs/learn/xcm/faq.md @@ -12,11 +12,11 @@ Yes. visit Polkadot.js, connect your wallet and go to Network > Balances and sel ## Q: I used XCM to transfer 5 DOT from Polkadot to Astar, but only received 4.999 -Please note that the gas amount will be deducted from the amount entered, so the amount transferred should be adjusted according to account for the gas fee estimate. For more information, visit [here](https://docs.astar.network/docs/xcm/using-xcm/xcm-transactions). +Please note that the gas amount will be deducted from the amount entered, so the amount transferred should be adjusted according to account for the gas fee estimate. For more information, visit here docs/learn/xcm/using-xcm/xcm-transactions (INSERT_LINK) ## Q: My balance should be 1.00012 DOT but the Portal is displaying 1 DOT, where are they? -The current version of Astar Portal rounds balances to the 3rd decimal. If you have a similar issue please refer to the [previous FAQ entry](building-with-xcm/faq-for-smart-contracts.md) and instructions on how to use Polkadot.js to find your exact balance. +The current version of Astar Portal rounds balances to the 3rd decimal. If you have a similar issue please refer to the [previous FAQ entry](/docs/learn/xcm/building-with-xcm/faq-for-smart-contracts) and instructions on how to use Polkadot.js to find your exact balance. ## Q: Can I send my DOT token to other Parachains? @@ -28,7 +28,7 @@ You can send back DOT/KSM to the Relay Chain using both EVM and native wallets. ## Q: Why is the XCM button for DOT/KSM disabled when I connect my wallet on the Astar Portal? -Ensure you have a non-zero balance of the native token as described in [this section](https://docs.astar.network/docs/xcm/using-xcm/xcm-transactions). +Ensure you have a non-zero balance of the native token as described in this section docs/learn/xcm/using-xcm/xcm-transactions (INSERT_LINK). ## Q: I transferred X tokens to another account, but the amount transferred and received by the target account is greater than X. What is going on? @@ -36,7 +36,7 @@ XC20 assets have a defined minimum-balance. The minimum-balance is the minimum b Take a look at an example of a transaction in case of an asset whose minimum-balance is 10: Alice has 10.9 tokens and tries to send Bob 10 tokens. Alice's remaining balance in that case would become 0.9, which is less than minimum amount, so the amount transferred would be set to 10.9 tokens, so Alice's balance will become 0, to avoid any funds being reaped by not fulfilling the Existential Deposit. -For more information, check out this[section within our documentation](building-with-xcm/send-xc20-evm.md). +For more information, check out this [section within our documentation](/docs/learn/xcm/building-with-xcm/send-xc20-evm.md). ## Q: Where can I find other chains' addresses? diff --git a/docs/learn/xcm/integration/add-to-portal.md b/docs/learn/xcm/integration/add-to-portal.md index 70a5217e41d3..a72b71969412 100644 --- a/docs/learn/xcm/integration/add-to-portal.md +++ b/docs/learn/xcm/integration/add-to-portal.md @@ -101,4 +101,4 @@ const xcmToken = { 2. Deposit and withdrawal functions have additionally been tested with the `minBridgeAmount`. 3. You've tested withdrawal of assets to accounts that have 0 balance of the assets being withdrawn (to check whether `minBridgeAmount` is higher than `Existential Deposit` defined on the origin chain). 4. You've included Subscan link(s) to the XCM transaction details, for each of the assets you've registered. -5. And finally, have deployed the forked app, and submitted the staging URL([ref](/docs/build/builder-guides/integration_toolings/deploy-astar-portal.md)). +5. And finally, have deployed the forked app, and submitted the staging URL [ref](/docs/build/builder-guides/integration_toolings/deploy-astar-portal.md). diff --git a/docs/use/Manage assets/manage-xc20-with-metamask.md b/docs/use/Manage assets/manage-xc20-with-metamask.md index 1fea371110f3..ba10d84e400a 100644 --- a/docs/use/Manage assets/manage-xc20-with-metamask.md +++ b/docs/use/Manage assets/manage-xc20-with-metamask.md @@ -27,6 +27,6 @@ Click on **Import Tokens** in MetaMask popup. ![8](img/8.png) -When you are finished adding and importing DOT, you will see them in your wallet. You can find the full list of supported XCM assets [here] (../asset-list.md). +When you are finished adding and importing DOT, you will see them in your wallet. You can find the full list of supported XCM assets [here](/docs/learn/xcm/asset-list). -To manually import assets that are not in *Assets page*, follow [this guide] (../building-with-xcm/send-xc20-evm.md#import-assets-on-metamask). +To manually import assets that are not listed on the *Assets page*, follow [this guide](/docs/learn/xcm/building-with-xcm/send-xc20-evm.md#import-assets-on-metamask). diff --git a/docs/use/Manage assets/transfer-tokens.md b/docs/use/Manage assets/transfer-tokens.md index 339b2aa6ad52..0703f25896d9 100644 --- a/docs/use/Manage assets/transfer-tokens.md +++ b/docs/use/Manage assets/transfer-tokens.md @@ -29,9 +29,9 @@ Astar Network supports addresses with two different formats: - An EVM address is used to interact with dApps on the Astar EVM -If you would like to create an Astar Native account, [this page](../Manage%20wallets/create-wallet.md) will guide you through the process. +If you would like to create an Astar Native account, [this page](/docs/use/Manage%20wallets/create-wallet) will guide you through the process. -If you have not added yet Astar Network to MetaMask, you can do it quickly and easily on our [Portal](https://portal.astar.network/) by choosing MetaMask from the Select Wallet menu, which should appear automatically. After selection, MetaMask will prompt you for permission to add Astar Network. Alternatively, you can visit [here](../EVM%20guides/setup-metamask.md) for details about how to add Astar Network to your wallet manually. +If you have not added yet Astar Network to MetaMask, you can do it quickly and easily on our [Portal](https://portal.astar.network/) by choosing MetaMask from the Select Wallet menu, which should appear automatically. After selection, MetaMask will prompt you for permission to add Astar Network. Alternatively, you can visit [here](/docs/use/EVM%20guides/setup-metamask) for details about how to add Astar Network to your wallet manually.
@@ -58,7 +58,7 @@ Most centralized exchanges only list 'Astar Network' as a destination, which mea network -3. Connect your Polkadot.js wallet - if you have not done it yet please go back to [Create Astar Accounts](#create-wallet/#astar-accounts). +3. Connect your Polkadot.js wallet - if you have not done it yet please go back to [Create Astar Accounts](/docs/use/Manage%20wallets/create-wallet.md). wallet　 @@ -90,7 +90,7 @@ In addition to the instructions below, please carefully read the instructions pr 1. Copy a deposit address from an exchange you wish to make a transfer to. 2. Visit the Astar [Portal](https://portal.astar.network/) and change the network to either Astar or Shiden (Astar Network uses ASTR token and Shiden uses SDN). -3. Connect your wallet (Native or EVM will depend on the exchange) - if you have not done this yet please revisit [Create Astar Accounts](https://docs.astar.network/docs/user-guides/create-wallet/). +3. Connect your wallet (Native or EVM will depend on the exchange) - if you have not done this yet please revisit [Create Astar Accounts](/docs/use/Manage%20wallets/create-wallet). 4. Click transfer button. Native-Asset-transfer 5. Add the destination address of the exchange and the amount you wish to transfer. diff --git a/docs/use/Manage assets/xcm-transactions.md b/docs/use/Manage assets/xcm-transactions.md index 08181e6cb1d6..6e3d7a83cbec 100644 --- a/docs/use/Manage assets/xcm-transactions.md +++ b/docs/use/Manage assets/xcm-transactions.md @@ -7,8 +7,8 @@ sidebar_position: 1 The following chapters will describe how to transfer native and foreign assets using Astar Portal. -### [Transferring cross-chain (XCM) assets to Astar Network](../Manage%20assets/transfer-tokens#transferring-cross-chain-xcm-assets-into-astar-network) +### [Transferring cross-chain (XCM) assets to Astar Network](/docs/use/Manage%20assets/transfer-tokens#transferring-cross-chain-xcm-assets-into-astar-network) -### [Transferring cross-chain (XCM) assets to other chains from Astar Network](../Manage%20assets/transfer-tokens#transferring-cross-chainxcm-assets-to-other-chains-from-astar-network) +### [Transferring cross-chain (XCM) assets to other chains from Astar Network](/docs/use/Manage%20assets/transfer-tokens#transferring-cross-chainxcm-assets-to-other-chains-from-astar-network) diff --git a/docs/use/user-guides/create-wallet.md b/docs/use/user-guides/create-wallet.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docusaurus.config.js b/docusaurus.config.js index 31dea02bf7d1..ab5bfab45930 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -13,7 +13,7 @@ const config = { url: 'https://docs.astar.network', baseUrl: '/', onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', + onBrokenMarkdownLinks: 'throw', favicon: 'img/fav.png', organizationName: 'AstarNetwork', // Usually your GitHub org/user name. projectName: 'astar-docs', // Usually your repo name. diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 5f857abfc19d..b68db7cef97a 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -28,7 +28,7 @@ export default function Home(): JSX.Element { return ( + description="Astar Network Official Documentation Portal - User Guides, Tutorials, and Tools for Developers.">