From db509c236e5227fd9699a698039a32c50e1d70ce Mon Sep 17 00:00:00 2001 From: bear Date: Mon, 20 May 2024 17:13:41 +0800 Subject: [PATCH] Fix broken links --- docs/build/ethereum-tools/verify-contract.md | 2 +- docs/build/getting-started/networks/dev-node.md | 6 +++--- docs/build/getting-started/networks/overview.md | 8 ++++---- docs/build/getting-started/wallets.md | 4 ++-- docs/build/precompiles/deposit.md | 2 +- docs/build/precompiles/overview.md | 2 +- docs/build/precompiles/staking.md | 2 +- docs/community/guide/migration/generate-account.md | 2 +- docs/community/guide/multisig-wallet.md | 2 +- docs/community/overview.md | 6 +++--- docs/learn/collator-staking.md | 2 +- docs/learn/ethereum-compatibility/evm-tracing.md | 4 ++-- docs/learn/ethereum-compatibility/jsonrpc.md | 2 +- docs/learn/faq.md | 4 ++-- docs/learn/governance.md | 2 +- docs/node-operators/run-collator-node.md | 10 +++++----- mkdocs.yml | 1 + 17 files changed, 31 insertions(+), 30 deletions(-) diff --git a/docs/build/ethereum-tools/verify-contract.md b/docs/build/ethereum-tools/verify-contract.md index a971344..7c384a8 100644 --- a/docs/build/ethereum-tools/verify-contract.md +++ b/docs/build/ethereum-tools/verify-contract.md @@ -6,7 +6,7 @@ For Darwinia chains, Subscan is the most commonly used explorer, offering contra ## Verify Contracts -1. Navigate to the appropriate [Subscan](../../learn/chains/crab.md#network-info) explorer, using the Crab chain as an example. Once there, open the contract page as demonstrated in the screenshot below. +1. Navigate to the appropriate [Subscan](../getting-started/networks/crab.md#network-info) explorer, using the Crab chain as an example. Once there, open the contract page as demonstrated in the screenshot below. ![evm-tutorial-verify-contract-1](../../images/evm-tutorial-verify-contract-1.png) diff --git a/docs/build/getting-started/networks/dev-node.md b/docs/build/getting-started/networks/dev-node.md index b867a3d..f5b654d 100644 --- a/docs/build/getting-started/networks/dev-node.md +++ b/docs/build/getting-started/networks/dev-node.md @@ -1,6 +1,6 @@ # Run Development Testnet -While there is an established test network, namely the [Pangolin network](../../learn/chains/pangolin.md), which serves as an ideal sandbox for your applications, eliminating any concern about initiating and connecting nodes, among other things. The official test network is designed to fulfill application developers' requirements. However, there may be scenarios where you want to perform low-level tasks. In such cases, creating your own development network can significantly enhance your development, testing, or debugging efficiency. This guide will walk you through the process of establishing a single-node development network. +While there is an established test network, namely the [Pangolin network](./pangolin.md), which serves as an ideal sandbox for your applications, eliminating any concern about initiating and connecting nodes, among other things. The official test network is designed to fulfill application developers' requirements. However, there may be scenarios where you want to perform low-level tasks. In such cases, creating your own development network can significantly enhance your development, testing, or debugging efficiency. This guide will walk you through the process of establishing a single-node development network. ## Compile darwinia node @@ -95,5 +95,5 @@ To start the local Substrate node: Once the node is up and producing new blocks, you can connect to the Polkadot app to explore more advanced features, such as token transfer and more. -![evm-tutorial-dev-node-1](../../images/evm-tutorial-dev-node-1.png) -![evm-tutorial-dev-node-2](../../images/evm-tutorial-dev-node-2.png) \ No newline at end of file +![evm-tutorial-dev-node-1](../../../images/evm-tutorial-dev-node-1.png) +![evm-tutorial-dev-node-2](../../../images/evm-tutorial-dev-node-2.png) \ No newline at end of file diff --git a/docs/build/getting-started/networks/overview.md b/docs/build/getting-started/networks/overview.md index 41cbc11..c1eb921 100644 --- a/docs/build/getting-started/networks/overview.md +++ b/docs/build/getting-started/networks/overview.md @@ -4,7 +4,7 @@ The Darwinia ecosystem consists of four official long-term networks: | Chain | Introduction | | :-------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------: | -| [Darwinia](../chains/darwinia.md) | EVM-compatible blockchain using the Substrate framework, featuring cross-chain capabilities. | -| [Crab](../chains/crab.md) | Canary network for Darwinia, similar to Kusama for Polkadot, designed to expect and handle chaos. | -| [Pangolin](../chains/pangolin.md) | Primary test network for Darwinia, maintained to rigorously test new features before mainnet deployment. | -| [Rollup](../chains/rollup.md) | Partnership with AltLayer to develop an advanced Ethereum Op Stack rollup testnet, supported by Avail DA, showcasing cutting-edge blockchain data services. | +| [Darwinia](./darwinia.md) | EVM-compatible blockchain using the Substrate framework, featuring cross-chain capabilities. | +| [Crab](./crab.md) | Canary network for Darwinia, similar to Kusama for Polkadot, designed to expect and handle chaos. | +| [Pangolin](./pangolin.md) | Primary test network for Darwinia, maintained to rigorously test new features before mainnet deployment. | +| [Rollup](./rollup.md) | Partnership with AltLayer to develop an advanced Ethereum Op Stack rollup testnet, supported by Avail DA, showcasing cutting-edge blockchain data services. | diff --git a/docs/build/getting-started/wallets.md b/docs/build/getting-started/wallets.md index bf7afaf..783b5e7 100644 --- a/docs/build/getting-started/wallets.md +++ b/docs/build/getting-started/wallets.md @@ -4,10 +4,10 @@ MetaMask is widely recognized as the leading wallet in the Ethereum ecosystem, with a substantial user base comprising millions of individuals. Considering that Darwinia's chain is Ethereum compatible, if you are already familiar with the tools and functionalities of the Ethereum ecosystem, we strongly recommend MetaMask as the preferred wallet for interacting with Darwinia's ecosystem products. -If you are new to MetaMask and have never used it before, [How to add a custom network RPC](https://support.metamask.io/hc/en-us/articles/360043227612-How-to-add-a-custom-network-RPC) is an excellent resource to begin with. [The Darwinia network information](./chains/overview.md) will be particularly useful when you want to add the Darwinia chains to your MetaMask. +If you are new to MetaMask and have never used it before, [How to add a custom network RPC](https://support.metamask.io/hc/en-us/articles/360043227612-How-to-add-a-custom-network-RPC) is an excellent resource to begin with. [The Darwinia network information](./networks/overview.md) will be particularly useful when you want to add the Darwinia chains to your MetaMask. ## [Talisman](https://www.talisman.xyz/) Talisman is a feature-rich wallet within the Polkadot ecosystem, offering support for both Polkadot chains and Ethereum-compatible chains. In the Darwinia chain, governance is conducted through the Polkadot Apps, which are fully compatible with Talisman. If you are already acquainted with the tools in the Polkadot ecosystem, we highly recommend Talisman as your go-to wallet, providing a seamless experience for managing your assets and participating in the Darwinia ecosystem. -If you are new to Talisman and have never used it before, [Create a Talisman Wallet](https://docs.talisman.xyz/talisman/navigating-the-paraverse/account-management/create-a-talisman-wallet) is an excellent resource to begin with. [The Darwinia network information](./chains/overview.md) will be particularly useful when you want to add the Darwinia chains to your Talisman. \ No newline at end of file +If you are new to Talisman and have never used it before, [Create a Talisman Wallet](https://docs.talisman.xyz/talisman/navigating-the-paraverse/account-management/create-a-talisman-wallet) is an excellent resource to begin with. [The Darwinia network information](./networks/overview.md) will be particularly useful when you want to add the Darwinia chains to your Talisman. \ No newline at end of file diff --git a/docs/build/precompiles/deposit.md b/docs/build/precompiles/deposit.md index fbec80b..e1eb4cb 100644 --- a/docs/build/precompiles/deposit.md +++ b/docs/build/precompiles/deposit.md @@ -1,6 +1,6 @@ # Deposit Precompile -The [Darwinia staking solution](../../collator-staking.md) consists of two components, including the staking pallet and the deposit pallet. Each of these pallets has its own precompile functionality, which is specifically designed to facilitate interaction for Ethereum users. In this context, we will focus on the deposit precompile. By leveraging the deposit precompile, Ethereum users can conveniently deposit their assets into the Darwinia network and participate in the staking process. +The [Darwinia staking solution](../../learn/collator-staking.md) consists of two components, including the staking pallet and the deposit pallet. Each of these pallets has its own precompile functionality, which is specifically designed to facilitate interaction for Ethereum users. In this context, we will focus on the deposit precompile. By leveraging the deposit precompile, Ethereum users can conveniently deposit their assets into the Darwinia network and participate in the staking process. ## Contract Info diff --git a/docs/build/precompiles/overview.md b/docs/build/precompiles/overview.md index 865e3d7..afe0299 100644 --- a/docs/build/precompiles/overview.md +++ b/docs/build/precompiles/overview.md @@ -7,7 +7,7 @@ Darwinia strives to achieve compatibility with Ethereum, which includes being RP ## Precompiles In Darwinia Networks -In the comprehensive Darwinia Ecosystem, each network serves a distinct purpose, resulting in the installation of different precompiles on each network. It is possible that a particular network requires a unique precompile to execute specific actions, while it is unnecessary and would introduce unnecessary overhead in other networks. To address this, it is crucial to provide a precompile list for each network. If you are unfamiliar with the relationship between these networks, please refer to [this answer](../../faq.md#what-distinguishes-the-darwinia-crab-and-pangolin-networks-from-each-other) for more information. +In the comprehensive Darwinia Ecosystem, each network serves a distinct purpose, resulting in the installation of different precompiles on each network. It is possible that a particular network requires a unique precompile to execute specific actions, while it is unnecessary and would introduce unnecessary overhead in other networks. To address this, it is crucial to provide a precompile list for each network. If you are unfamiliar with the relationship between these networks, please refer to [this answer](../../learn/faq.md#what-distinguishes-the-darwinia-crab-and-pangolin-networks-from-each-other) for more information. ### Darwinia Network diff --git a/docs/build/precompiles/staking.md b/docs/build/precompiles/staking.md index bc6403c..07fcd8a 100644 --- a/docs/build/precompiles/staking.md +++ b/docs/build/precompiles/staking.md @@ -1,6 +1,6 @@ # Staking Precompile -To fully understand the concept of the precompile and its significance in the context of the Darwinia staking solution, it is important to have a grasp of the overall design of the staking solution. [The Darwinia staking](../../collator-staking.md) solution is implemented as a pallet, which is a modular component in the Substrate framework. Pallets are native to Substrate and provide a way to encapsulate and organize blockchain logic. However, they are not inherently compatible with Ethereum tools and infrastructure. One consequence of this design is that accessing the staking API with tools like MetaMask, which are commonly used in Ethereum development, is not possible out of the box. This is because MetaMask expects to interact with Ethereum-compatible contracts and APIs, and the staking solution implemented as a pallet in Darwinia does not natively adhere to those standards. +To fully understand the concept of the precompile and its significance in the context of the Darwinia staking solution, it is important to have a grasp of the overall design of the staking solution. [The Darwinia staking](../../learn/collator-staking.md) solution is implemented as a pallet, which is a modular component in the Substrate framework. Pallets are native to Substrate and provide a way to encapsulate and organize blockchain logic. However, they are not inherently compatible with Ethereum tools and infrastructure. One consequence of this design is that accessing the staking API with tools like MetaMask, which are commonly used in Ethereum development, is not possible out of the box. This is because MetaMask expects to interact with Ethereum-compatible contracts and APIs, and the staking solution implemented as a pallet in Darwinia does not natively adhere to those standards. To bridge this gap and enable interaction with the staking API using Ethereum tools, the staking precompile comes into play. The staking precompile refers to a specific implementation that exposes the staking API in a format that is compatible with Ethereum tools such as MetaMask. By utilizing the staking precompile, developers can seamlessly integrate the Darwinia staking solution with their Ethereum workflows and tools. diff --git a/docs/community/guide/migration/generate-account.md b/docs/community/guide/migration/generate-account.md index 8cd2ae8..26674ac 100644 --- a/docs/community/guide/migration/generate-account.md +++ b/docs/community/guide/migration/generate-account.md @@ -55,7 +55,7 @@ The current version of [Subscan](https://darwinia.subscan.io/) supports Darwinia ![evm-tutorial-migrate-general-8](../../../images/evm-tutorial-migrate-general-8.png) ![evm-tutorial-migrate-general-9](../../../images/evm-tutorial-migrate-general-9.png) -Also, you can refer to [here](../../../learn/chains/darwinia.md#network-info) and add the darwinia RPC to your wallet. Then you can see the transferrable `RING` on MetaMask. +Also, you can refer to [here](../../../build/getting-started/networks/darwinia.md#network-info) and add the darwinia RPC to your wallet. Then you can see the transferrable `RING` on MetaMask. ![evm-tutorial-migrate-general-10](../../../images/evm-tutorial-migrate-general-10.png) diff --git a/docs/community/guide/multisig-wallet.md b/docs/community/guide/multisig-wallet.md index 8faa563..2cceebd 100644 --- a/docs/community/guide/multisig-wallet.md +++ b/docs/community/guide/multisig-wallet.md @@ -12,7 +12,7 @@ 1. Open [DSafe Wallet](https://multisig.darwiniacommunitydao.xyz/) 2. Switch your MetaMask to the Darwinia Chain - DSafe Wallet consists of multiple owners. To create a multi-signature wallet, you first need to connect your regular wallet using MetaMask (or any other compatible wallet). If you haven't added the Darwinia Chain before, you can add it by visiting this [link](../../learn/chains/darwinia.md#network-info). + DSafe Wallet consists of multiple owners. To create a multi-signature wallet, you first need to connect your regular wallet using MetaMask (or any other compatible wallet). If you haven't added the Darwinia Chain before, you can add it by visiting this [link](../../build/getting-started/networks/darwinia.md#network-info). 3. Click "Create new Account" to initiate the process. diff --git a/docs/community/overview.md b/docs/community/overview.md index 8d689dd..67fbf9a 100644 --- a/docs/community/overview.md +++ b/docs/community/overview.md @@ -13,9 +13,9 @@ Darwinia is supported by dedicated organizations, each playing a critical role i | Organization | Purpose | | --- | --- | -| [**RingDAO**](../community/ringdao.md) | Focused on governance decisions, RingDAO allows RING token holders to participate directly in the decision-making processes, ensuring that Darwinia remains a truly decentralized network. | -| [**DCDAO**](../community/dcdao.md) | DCDAO is a community self-organized workgroup (WG) that aims to contribute to the growth and development of the Darwinia community. | -| [**KtonDAO**](../community/ktondao.md) | KtonDAO is a community initiative primarily initiated and conceived by KTON holders. Although it is not yet fully formed, there have been some [forum discussions](https://github.com/orgs/dcdao/discussions/32). KTON is designed to specialize in long-term staking incentives and reward strategies, encouraging long-term commitment from network supporters. | +| [**RingDAO**](./orgs/ringdao.md) | Focused on governance decisions, RingDAO allows RING token holders to participate directly in the decision-making processes, ensuring that Darwinia remains a truly decentralized network. | +| [**DCDAO**](./orgs/dcdao.md) | DCDAO is a community self-organized workgroup (WG) that aims to contribute to the growth and development of the Darwinia community. | +| [**KtonDAO**](./orgs/ktondao.md) | KtonDAO is a community initiative primarily initiated and conceived by KTON holders. Although it is not yet fully formed, there have been some [forum discussions](https://github.com/orgs/dcdao/discussions/32). KTON is designed to specialize in long-term staking incentives and reward strategies, encouraging long-term commitment from network supporters. | | **Itering** | Itering is a blockchain technology development company that provides runtime and smart contract engineering implementations for Darwinia. It is also the founding company of Darwinia. | | **Crab SubDAO** | Crab SubDAO is a DAO currently in design and will exist as a SubDAO of RingDAO. CRAB is its governance token, which is expected to be used for governing the Crab Chain, the experimental canary chain of Darwinia Chain. The design and concept of the SubDAO are inspired by Maker SubDAO. | diff --git a/docs/learn/collator-staking.md b/docs/learn/collator-staking.md index 72422e7..e343822 100644 --- a/docs/learn/collator-staking.md +++ b/docs/learn/collator-staking.md @@ -7,4 +7,4 @@ Collator staking involves participants locking up their RING tokens to support t ## Development -If you want to learn how to interact with these Collator Staking module, pleast vist the [Staking Precompile Page](./ethereum-compatibility/precompiles/staking.md), be aware that this contract may be deprecated in future versions. \ No newline at end of file +If you want to learn how to interact with these Collator Staking module, please visit the [Staking Precompile Page](../build/precompiles/staking.md), be aware that this contract may be deprecated in future versions. \ No newline at end of file diff --git a/docs/learn/ethereum-compatibility/evm-tracing.md b/docs/learn/ethereum-compatibility/evm-tracing.md index f270db1..057e51b 100644 --- a/docs/learn/ethereum-compatibility/evm-tracing.md +++ b/docs/learn/ethereum-compatibility/evm-tracing.md @@ -18,6 +18,6 @@ These APIs enable developers to examine and analyze the execution details of the It is worth noting that the EVM tracing features in Darwinia are specifically provided by a dedicated type of node. This design decision is made to ensure that the tracing feature is only enabled when needed, avoiding unnecessary overhead for production nodes. -The EVM tracing node in Darwinia has its own distinct binary and requires a separate setup command compared to the production node. For more detailed information on running an EVM tracing node, please refer to the [Run Evm Trace Node](../../build/chain/run-evm-tracing-node.md). +The EVM tracing node in Darwinia has its own distinct binary and requires a separate setup command compared to the production node. For more detailed information on running an EVM tracing node, please refer to the [Run Evm Trace Node](../../node-operators/run-evm-tracing-node.md). -To utilize the EVM tracing features in Darwinia, users should send requests to the dedicated node's RPC endpoint, which can be found in the corresponding [Network Info](../chains/pangolin.md#network-info). This ensures that the tracing capabilities are utilized effectively and efficiently within the Darwinia ecosystem. \ No newline at end of file +To utilize the EVM tracing features in Darwinia, users should send requests to the dedicated node's RPC endpoint, which can be found in the corresponding [Network Info](../../build/getting-started/networks/pangolin.md#network-info). This ensures that the tracing capabilities are utilized effectively and efficiently within the Darwinia ecosystem. \ No newline at end of file diff --git a/docs/learn/ethereum-compatibility/jsonrpc.md b/docs/learn/ethereum-compatibility/jsonrpc.md index d95d87b..899c530 100644 --- a/docs/learn/ethereum-compatibility/jsonrpc.md +++ b/docs/learn/ethereum-compatibility/jsonrpc.md @@ -1,4 +1,4 @@ -To enable a software application to interact with the blockchain, JSON RPC is the preferred method. Darwinia provides an [Ethereum-compatible JSON RPC endpoint](../chains/darwinia.md#network-info), allowing developers to seamlessly interact with the Darwinia node just as they would with [Ethereum API](https://ethereum.github.io/execution-apis/api-documentation). While these APIs strive for high compatibility with Ethereum, it's important to acknowledge that there may be variations, particularly in relation to the consensus mechanism. The details of these differences will be explained in the accompanying guide. +To enable a software application to interact with the blockchain, JSON RPC is the preferred method. Darwinia provides an [Ethereum-compatible JSON RPC endpoint](../../build/getting-started/networks/darwinia.md#network-info), allowing developers to seamlessly interact with the Darwinia node just as they would with [Ethereum API](https://ethereum.github.io/execution-apis/api-documentation). While these APIs strive for high compatibility with Ethereum, it's important to acknowledge that there may be variations, particularly in relation to the consensus mechanism. The details of these differences will be explained in the accompanying guide. !!! note ✅ means the method is fully compatible with the Ethereum, and ❌ means it is not. diff --git a/docs/learn/faq.md b/docs/learn/faq.md index 85dc4c7..5ae5a0d 100644 --- a/docs/learn/faq.md +++ b/docs/learn/faq.md @@ -2,11 +2,11 @@ ## What distinguishes the Darwinia, Crab and Pangolin networks from each other? -See [Chains](./chains/overview.md) +See [Chains](../build/getting-started/networks/overview.md) ## Why is there a Darwinia 2.0? -Great question! Before the [Merge](https://medium.com/darwinianetwork/darwinia-2-0-merge-overview-96af96d668aa), the Darwinia 1.0 era included six networks within the Darwinia Ecosystem: the Darwinia Solo Network, Crab Solo Network, Darwinia Parachain Network, Crab Parachain Network, and two test networks. However, having so many networks caused confusion among users, making it difficult to understand their relationships. To address this, we decided to merge the Darwinia Solo Network into the Darwinia Parachain Network, and the Crab Solo Network into the Crab Parachain Network. This merge not only simplified the network structure but also resolved technical issues such as account system and crypto primitive compatibility with Ethereum. If you have an account in the Darwinia 1.0 network, we have developed a user-friendly application to assist you with migrating your assets to the Darwinia 2.0 network. Be sure to check out our [tutorial](../build/getting-started/migration/generate-account.md) for more information. +Great question! Before the [Merge](https://medium.com/darwinianetwork/darwinia-2-0-merge-overview-96af96d668aa), the Darwinia 1.0 era included six networks within the Darwinia Ecosystem: the Darwinia Solo Network, Crab Solo Network, Darwinia Parachain Network, Crab Parachain Network, and two test networks. However, having so many networks caused confusion among users, making it difficult to understand their relationships. To address this, we decided to merge the Darwinia Solo Network into the Darwinia Parachain Network, and the Crab Solo Network into the Crab Parachain Network. This merge not only simplified the network structure but also resolved technical issues such as account system and crypto primitive compatibility with Ethereum. If you have an account in the Darwinia 1.0 network, we have developed a user-friendly application to assist you with migrating your assets to the Darwinia 2.0 network. Be sure to check out our [tutorial](../community/guide/migration/generate-account.md) for more information. ## Where can I buy Darwinia Tokens? diff --git a/docs/learn/governance.md b/docs/learn/governance.md index 0e27f0b..015ae13 100644 --- a/docs/learn/governance.md +++ b/docs/learn/governance.md @@ -4,7 +4,7 @@ Currently, Darwinia employs OpenGov for governance. For more details on how it f Darwinia plans to transition from OpenGov to Tally in the future. -Check out the [tutorial](../build/getting-started/governance.md). +Check out the [tutorial](../community/guide/governance.md). ## Parameters diff --git a/docs/node-operators/run-collator-node.md b/docs/node-operators/run-collator-node.md index f51c16f..83af2a6 100644 --- a/docs/node-operators/run-collator-node.md +++ b/docs/node-operators/run-collator-node.md @@ -153,19 +153,19 @@ It's important to note that there is a faster method to expedite the syncing pro 1. Once your node has finished syncing, ensure that it is still running. 2. Open the [staking app](https://staking.darwinia.network/#/?network=darwinia) in your browser and connect it to your wallet account. You have the option to choose between MetaMask or WalletConnect, as both wallets are now supported. - ![evm-tutorial-collator-node-1](../../images/evm-tutorial-collator-node-1.png) + ![evm-tutorial-collator-node-1](../images/evm-tutorial-collator-node-1.png) 3. Click on the `Join Collator` button and follow these steps: 1. Enter the session key that was generated earlier and click on `Set Session Key` to prompt the wallet for submitting an Ethereum transaction. 2. Enter the desired commission amount and click on `Set Commission` to prompt the wallet for submitting an Ethereum transaction. -![evm-tutorial-collator-node-2](../../images/evm-tutorial-collator-node-2.png) -![evm-tutorial-collator-node-3](../../images/evm-tutorial-collator-node-3.png) +![evm-tutorial-collator-node-2](../images/evm-tutorial-collator-node-2.png) +![evm-tutorial-collator-node-3](../images/evm-tutorial-collator-node-3.png) 1. To verify that your account is in the collator waiting pool, click on the `Select a collator` button. - ![evm-tutorial-collator-node-4](../../images/evm-tutorial-collator-node-4.png) - ![evm-tutorial-collator-node-5](../../images/evm-tutorial-collator-node-5.png) + ![evm-tutorial-collator-node-4](../images/evm-tutorial-collator-node-4.png) + ![evm-tutorial-collator-node-5](../images/evm-tutorial-collator-node-5.png) ## To be a real collator diff --git a/mkdocs.yml b/mkdocs.yml index f611259..085cea7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -124,6 +124,7 @@ markdown_extensions: - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde + plugins: - search