diff --git a/docs/build/getting-started/networks/crab.md b/docs/build/getting-started/networks/crab.md index c6e3676..dffeaad 100644 --- a/docs/build/getting-started/networks/crab.md +++ b/docs/build/getting-started/networks/crab.md @@ -4,11 +4,11 @@ Crab serves as Darwinia's canary network with genuine economic significance, aki Crab is now a [parachain of Kusama](https://kusama.subscan.io/parachain/2105). -## Connect Wallet +## Connect Wallet Automatically -[Connect automatically](https://chainlist.org/chain/44){ .md-button .md-button--primary } +[Connect](https://chainlist.org/chain/44){ .md-button .md-button--primary } -## Network Info +## Network Information - Network Name: **Crab2** - ChainId: **`44`** diff --git a/docs/build/getting-started/networks/darwinia.md b/docs/build/getting-started/networks/darwinia.md index 6eed855..1f580ac 100644 --- a/docs/build/getting-started/networks/darwinia.md +++ b/docs/build/getting-started/networks/darwinia.md @@ -6,11 +6,11 @@ It is designed to provide secure and scalable interoperability between different Darwinia is now a [parachain of Polkadot](https://polkadot.subscan.io/parachain/2046). -## Connect Wallet +## Connect Wallet Automatically -[Connect automatically](https://chainlist.org/chain/46){ .md-button .md-button--primary } +[Connect](https://chainlist.org/chain/46){ .md-button .md-button--primary } -## Network Info +## Network Information - Network Name: **Darwinia2** - ChainId: **46** diff --git a/docs/build/getting-started/networks/pangolin.md b/docs/build/getting-started/networks/pangolin.md index e5b9527..7595c06 100644 --- a/docs/build/getting-started/networks/pangolin.md +++ b/docs/build/getting-started/networks/pangolin.md @@ -2,9 +2,9 @@ The Pangolin acts as the primary test network for Darwinia, officially maintained to ensure that new and innovative features are thoroughly tested before they are deployed to the main production network. -## Connect Wallet +## Connect Wallet Automatically -[Connect automatically](https://chainlist.org/chain/43){ .md-button .md-button--primary } +[Connect](https://chainlist.org/chain/43){ .md-button .md-button--primary } ## Faucet @@ -13,7 +13,7 @@ The Pangolin acts as the primary test network for Darwinia, officially maintaine To obtain the test token, go to the [faucet-testnet](https://discord.com/channels/456092011347443723/1115885903605411850) channel on Discord and send `/faucet pangolin address` to get test tokens. -## Network Info +## Network Information - Network Name: **Pangolin2** - Token Info: diff --git a/docs/build/getting-started/networks/rollup.md b/docs/build/getting-started/networks/rollup.md index 0288bfd..c35c35f 100644 --- a/docs/build/getting-started/networks/rollup.md +++ b/docs/build/getting-started/networks/rollup.md @@ -2,7 +2,7 @@ The Darwinia team has collaborated with [AltLayer](https://altlayer.io/), a leading Rollup-as-a-Service (RaaS) provider, to create an advanced Ethereum Op Stack rollup testnet. This new testnet is supported by [Avail DA](https://www.availproject.org/), which represents the forefront of blockchain data services. We invite you to experience the latest in rollup technology by trying out this state-of-the-art testnet. -## Network Info +## Network Information - ChainID: **20240207** - Settlement Layer: **Sepolia Testnet** diff --git a/docs/community/guide/migration/generate-account.md b/docs/community/guide/migration/generate-account.md index 26674ac..b7e3181 100644 --- a/docs/community/guide/migration/generate-account.md +++ b/docs/community/guide/migration/generate-account.md @@ -7,7 +7,7 @@ This tutorial will walk you through the steps of migrating your accounts from `Darwinia 1.0` to the current Darwinia using the [Account Migration Dapp](https://migration.darwinia.network/#/?network=Darwinia). It's important to note that this tutorial is also applicable for the Crab chain. -## Get started with the dashboard +## Get Started With The Dashboard To get started with the dashboard, navigate to [migration.darwinia.network](https://migration.darwinia.network/#/?network=Darwinia). You’ll be prompted to connect to [polkadot{.js} extension](https://polkadot.js.org/extension/), [Talisman wallet](https://www.talisman.xyz/), [Subwallet](https://subwallet.app/), or [NovaWallet](https://novawallet.io/). @@ -17,7 +17,7 @@ Upon accepting the permission, you will be directed to the main dashboard where ![evm-tutorial-migrate-general-2](../../../images/evm-tutorial-migrate-general-2.png) -## How to migrate +## How to Migrate For the purpose of account migration operations, we will use the following account as an example: `2ryX5gyPDyctCfgqGdUknkfBDftpcpSnTP9gtgJGaqdpLiCB` @@ -46,7 +46,7 @@ Once the transaction has been confirmed and you receive the transaction confirme That’s it! Now you’ve successfully migrated the account. Please don’t forget to check your account after the migration is complete. -## Check your account after the migration +## Check Your Account After The Migration ### Transferrable diff --git a/docs/community/guide/migration/multisig-account.md b/docs/community/guide/migration/multisig-account.md index 927d6f4..9a6d986 100644 --- a/docs/community/guide/migration/multisig-account.md +++ b/docs/community/guide/migration/multisig-account.md @@ -6,7 +6,7 @@ This tutorial will walk you through the steps of migrating your accounts from `Darwinia 1.0` to the current Darwinia using the [Multisig Account Migration Dapp](https://migration.darwinia.network/#/multisig-home?network=Darwinia). It's important to note that this tutorial is also applicable for the Crab chain. -## Get started with the dashboard +## Get Started With The Dashboard To get started with the dashboard, navigate to [migration.darwinia.network.](https://migration.darwinia.network/#/multisig-home?network=Darwinia) You’ll be prompted to connect to [polkadot{.js} extension](https://polkadot.js.org/extension/), [Talisman wallet](https://www.talisman.xyz/), [Subwallet](https://subwallet.app/), or [NovaWallet](https://novawallet.io/). @@ -17,7 +17,7 @@ After granting the necessary permissions, you will be redirected to the main das ![evm-tutorial-migrate-multisig-2](../../../images/evm-tutorial-migrate-multisig-2.png) ![evm-tutorial-migrate-multisig-3](../../../images/evm-tutorial-migrate-multisig-3.png) -## How to migrate +## How to Migrate !!! note Please note that you can use [Gnosis Safe Multisig - IPFS](https://ipfs.io/ipfs/QmfRD4GuqZobNi2NT2C77a3UTQ452ffwstr4fjEJixUgjf/#/wallets) to restore the current Darwinia multisig account that you previously created and perform multisig operations on the current Darwinia. diff --git a/docs/community/guide/staking.md b/docs/community/guide/staking.md index 4e3fbed..09779d2 100644 --- a/docs/community/guide/staking.md +++ b/docs/community/guide/staking.md @@ -2,7 +2,7 @@ This tutorial will guide you through the process of staking tokens (RING & KTON & Deposit) on Darwinia using the staking Dapp built by the Darwinia Dev Team. The staking Dapp is compatible with the Crab network. Be sure to select Crab network if you want to stake Crab tokens (CRAB & CKTON & Deposit), this tutorial also works; just switch to the appropriate network. -## Get started with the dashboard +## Get Started With The Dashboard To get started with the dashboard, navigate to [staking.darwinia.network](https://staking.darwinia.network/#/?network=Darwinia). You’ll be prompted to connect to [MetaMask](https://metamask.io/). @@ -10,7 +10,7 @@ MetaMask will pop up and ask you to sign in. Once signed in, you will be prompte Upon accepting permissions and changing the network to `Darwinia`, you will be redirected to the main dashboard where you’ll find details about the staking data. -## How to stake +## How to Stake Token holders can delegate a collator candidate by staking tokens and adding to the collator's stake. In return, the collator will share the rewards received from producing blocks amongst all of their delegators. For more information on reward distribution, check out our documentation on [staking reward distribution](https://medium.com/darwinianetwork/faqs-for-darwinia-2-0-staking-mechanism-adjustments-f330b549f168). @@ -52,9 +52,9 @@ If you check your MetaMask account, you will see that your balance has decreased ![evm-tutorial-staking-6](../../images/evm-tutorial-staking-6.png) -## How to make changes to delegation +## Make Changes To The Delegation -### How to bond more funds +### How to Bond More Funds 1. Click the `+` icon next to the token you want to modify. 2. Specify the amount you would like to increase your delegation by. In this case, we are increasing our bond by 5`RING`. @@ -63,7 +63,7 @@ If you check your MetaMask account, you will see that your balance has decreased ![evm-tutorial-staking-7](../../images/evm-tutorial-staking-7.png) ![evm-tutorial-staking-8](../../images/evm-tutorial-staking-8.png) -### How to reduce funds +### How to Reduce Funds 1. Click on the `–` icon next to the token you want to modify. 2. Enter the amount you would like to reduce your bond by. In this case, we are reducing our bond by 0.0001`KTON`. @@ -80,7 +80,7 @@ Once the transaction has been confirmed and you receive the Transaction confirme Once the 14 days unbonding period has passed, you can return to this staking dashboard and release the unbonded tokens, after which you will see the unbonded funds in your free balance on MetaMask. -### How to undelegate +### How to Undelegate Undelegating usually involves two steps: undelegating of the collator and unbonding the tokens that were previously bonded in the stake. To undelegate, click the `Undelegate` button. This action will take effect immediately. Then, press the `Unbond all` button to unbond the tokens. This will initiate the 14-day unbonding period. After the period is over, you will need to manually release the tokens before they can be transferred. diff --git a/docs/community/orgs/dcdao.md b/docs/community/orgs/dcdao.md index ed2dce1..0c6916b 100644 --- a/docs/community/orgs/dcdao.md +++ b/docs/community/orgs/dcdao.md @@ -2,7 +2,7 @@ The Darwinia Community DAO (DCDAO) is a community self-organized workgroup (WG) that aims to contribute to the growth and development of the Darwinia community. Sponsored by the Darwinia Treasury and Itering, the DCDAO welcomes donations and contributions from community members who share its vision and objectives. -## Resources +## Available Resources * Snapshot: https://snapshot.org/#/darwiniacommunitydao.eth * Forum: https://github.com/dcdao/discussion diff --git a/docs/community/orgs/ringdao.md b/docs/community/orgs/ringdao.md index b9ffb04..24c18f4 100644 --- a/docs/community/orgs/ringdao.md +++ b/docs/community/orgs/ringdao.md @@ -2,7 +2,7 @@ RingDAO is a upcoming DAO based using [Tally](https://www.tally.xyz/) on Darwinia Chain, intended for governing the Darwinia Chain in its next version. It is currently under development and implementation. [**RING**](https://coinmarketcap.com/currencies/darwinia-network/) will be the govenance token of RingDAO. RING has an initial supply of 2 billion tokens, and its token model can be found in [Genepaper V4](https://darwinia.network/Genepaper_v4.pdf). -## Other projects governed by RingDAO +## Other Projects Governed By The RingDAO * [Msgport](https://docs.msgport.xyz/) * [XAPI](https://github.com/xapi-box) \ No newline at end of file diff --git a/docs/learn/collator-staking.md b/docs/learn/collator-staking.md index e343822..1b9c452 100644 --- a/docs/learn/collator-staking.md +++ b/docs/learn/collator-staking.md @@ -5,6 +5,6 @@ Collator staking involves participants locking up their RING tokens to support the network’s operations and security through a nomination mechanism. In this system, users can participate either as nominators or collators to help the chain's liveness, earning rewards in return. To get started with the DApp, visit [Collator Staking App](https://collator-staking.darwinia.network/). -## Development +## Interact with Staking 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/governance.md b/docs/learn/governance.md index 9e7e1d1..3c1c050 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 Check out the [tutorial](../community/guide/governance.md) for how to use it. -## Parameters +## Key Parameters | Origin/Track | Usage | Prepare Period | Decision Period | Confirm Period | Min Enactment Period | | :------------------: | :---------------------------------------------: | :-------------: | :-------------: | :------------: | :------------------: | diff --git a/docs/node-operators/run-collator-node.md b/docs/node-operators/run-collator-node.md index 83af2a6..ffd2c7b 100644 --- a/docs/node-operators/run-collator-node.md +++ b/docs/node-operators/run-collator-node.md @@ -168,7 +168,7 @@ It's important to note that there is a faster method to expedite the syncing pro ![evm-tutorial-collator-node-5](../images/evm-tutorial-collator-node-5.png) -## To be a real collator +## To Be A Real Collator 1. Accumulate power by staking or depositing diff --git a/docs/node-operators/run-evm-tracing-node.md b/docs/node-operators/run-evm-tracing-node.md index a1c6abd..a400d8e 100644 --- a/docs/node-operators/run-evm-tracing-node.md +++ b/docs/node-operators/run-evm-tracing-node.md @@ -9,7 +9,7 @@ As you may be aware, Darwinia chains are EVM compatible, which means that the RP - **RAM:** 8 GB: - **Storage(SSD)**: 800 GB -### Prepare the tracing binary and overridden wasms +### Prepare Tracing Binary And Overridden Wasms 1. Create a work dirctory @@ -45,7 +45,7 @@ As you may be aware, Darwinia chains are EVM compatible, which means that the RP The `wasm-runtime-overrides` repository has four branches, each corresponding to one of the four Darwinia chains. You will need to switch to the branch that corresponds to your desired network and copy the `wasm` directory to your temporary workaround location. In this tutorial, we will use the `pangolin` branch. -### Start the evm tracing node +### Start The EVM Tracing Node 1. Start the node by running the following command: diff --git a/docs/resource/stylesheets/extra.css b/docs/resource/stylesheets/extra.css index c8eee29..aba786b 100644 --- a/docs/resource/stylesheets/extra.css +++ b/docs/resource/stylesheets/extra.css @@ -4,4 +4,20 @@ [data-md-color-scheme="slate"] { --md-primary-fg-color: rgb(189, 45, 120); + .md-typeset h1 { + color: rgb(189, 45, 120); + } + .md-typeset h2, h3, h4 { + color: rgb(245, 157, 33); + } +} + +.md-header__title > .md-header__ellipsis > .md-header__topic > .md-ellipsis { + font-family: Montserrat Thin; + font-size: 18; + font-weight: 400; +} + +.md-nav__link--active > span { + font-weight: bold; } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 14cea10..39fc9cd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,7 @@ -site_name: Darwinia Docs +site_name: Darwinia Network Documentation site_url: https://docs.darwinia.network/ site_description: "This is the official documentation for the Darwinia Network. It covers the design, usage and integration guide for Darwinia networks." copyright: Copyright © Darwinia Network -repo_url: https://github.com/darwinia-network/docs repo_name: darwinia-network/docs edit_uri: https://github.com/darwinia-network/docs/edit/main/docs theme: @@ -81,7 +80,7 @@ extra: data: 0 note: >- Thanks for your feedback! Help us improve this page by - using our feedback form. + using our feedback form. consent: title: Cookie consent description: >-