Chore update (#42)

* Chore update * Fix the unfinished part
darwinia-network · Apr 28, 2024 · 31411a9 · 31411a9
1 parent 90d5723
commit 31411a9
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 66 deletions.
diff --git a/docs/community/collaboration.md b/docs/community/collaboration.md
diff --git a/docs/community/dcdao.md b/docs/community/dcdao.md
@@ -2,8 +2,8 @@
 
 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
+## Resources
 
-1. Snapshot: https://snapshot.org/#/darwiniacommunitydao.eth
-2. Forum: https://github.com/dcdao/discussion
-3. Membership: https://github.com/dcdao/profiles
+* Snapshot: https://snapshot.org/#/darwiniacommunitydao.eth
+* Forum: https://github.com/dcdao/discussion
+* Membership: https://github.com/dcdao/profiles
diff --git a/docs/community/ktondao.md b/docs/community/ktondao.md
@@ -1,31 +1,9 @@
-# Join the Disucssion
+# Overview
 
 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.
 
 # KTON and KTON Staking
 
-KTON was introduce to incentive and exchange for the long commitment of RING. The initial supply of this token is zero, and it is specifically minted when a user participates in the deposit system by locking RING for a predetermined period. This serves as a incentive for contributing commitment of *RING*. Once acquired, KTON can be utilized to participate in the [KTON Staking](https://kton-staking.darwinia.network/) grogram.
-
-Take the Darwinia chain as an example, users have the option to lock their *RING* for a maximum of 36 months during the staking process. As a form of reward for their participation in staking, the system grants users *KTON*. It is crucial to note that users cannot unlock their *RING* during the committed pledge period unless they forfeit triple the amount of *KTON* from their accounts as a penalty. Consequently, during the *RING* staking process, users have the discretion to lock their *RING* for a specific period and receive *KTON* in return.
-
-## KTON Specification
-
-KTON spec can be found on Darwinia [Notion](https://darwinia.notion.site/KTON-Specification-on-Different-Chains-cbb4b2f65c12421282f5f19e310a82d2?pvs=74)
-
-## Deposit Precompile
-TBD
-
-## Extrinsic API
-
-- `lock(amount: Balance, months: u8)`
-    - Lock *RING* for some *KTON* profit/interest.
-    - Params:
-        - `amount` : the quantity to be locked.
-        - `months` : the duration for which the amount is to be locked.
-- `claim()`
-    - Claim the expired-locked *RING*.
-- `claim_with_penalty(deposit_id: DepositId)`
-    - Claim the unexpired-locked *RING* by paying the *KTON* penalty.
-    - Params:
-        - `deposit_id`: the specific deposit that you intend to claim.
+KTON was introduce to incentive and exchange for the long commitment of RING. The initial supply of this token is zero, and it is specifically minted when a user participates in the deposit system by locking RING for a predetermined period. The comprehensive spec can be found on Darwinia [Notion](https://darwinia.notion.site/KTON-Specification-on-Different-Chains-cbb4b2f65c12421282f5f19e310a82d2?pvs=74). This serves as a incentive for contributing commitment of *RING*. Once acquired, KTON can be utilized to participate in the [KTON Staking](https://kton-staking.darwinia.network/) grogram.
 
+Take the Darwinia chain as an example, users have the option to lock their *RING* for a maximum of 36 months during the staking process. As a form of reward for their participation in staking, the system grants users *KTON*. It is crucial to note that users cannot unlock their *RING* during the committed pledge period unless they forfeit triple the amount of *KTON* from their accounts as a penalty. Consequently, during the *RING* staking process, users have the discretion to lock their *RING* for a specific period and receive *KTON* in return.
diff --git a/docs/community/overview.md b/docs/community/overview.md
@@ -2,16 +2,32 @@
 
 Welcome to Darwinia, a community-run blockchain network designed to enhance the cross-chain capabilities of decentralized applications. Darwinia leverages cutting-edge technology to facilitate seamless and secure inter-blockchain transactions. This document introduces you to the vibrant organizations and innovative projects that underpin our ecosystem.
 
-# Community Organizations
+## Roadmap
+
+The roadmap for the ecosystem is outlined at [Darwinia Roadmap](https://itering.notion.site/9617e154ec884b07a7cee9a056374e42?v=0c3e4d9f257646c486a32a0425ee3a93). It provides a clear vision for the future of the Darwinia ecosystem and should be consulted by developers looking to join and contribute to this exciting project.
+
+
+## Community Organizations
 
 Darwinia is supported by dedicated organizations, each playing a critical role in governance, development, and the enhancement of our network:
 
-  - **RingDAO:** 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.
+| 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. |
+| **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. |
 
-  - **DCDAO:**  DCDAO is a community self-organized workgroup (WG) that aims to contribute to the growth and development of the Darwinia community.
+## Community Collaboration
 
-  - **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.
+We wholeheartedly believe in the power of collaboration and warmly invite additional decentralized applications to join our rapidly expanding Darwinia ecosystem. To facilitate this, we have launched the Community Developer Incentive Program. This program consists of:
 
-  - **KtonDAO:** 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.
+| Project | Purpose |
+| --- | --- |
+| [The Immunefi Bounty Program](https://immunefi.com/bounty/darwinia/) | It offers rewards for finding potential flaws in our products. |
+| [RFP (Request For Proposals)](https://github.com/darwinia-network/collaboration/issues) | Provides a selection of potential projects or tasks for members of the ecosystem. |
+| [Grant Program](https://github.com/darwinia-network/collaboration/blob/master/grant/README.md) | To fund the development of projects and applications that contribute to the Darwinia ecosystem and promote overall network growth, we encourage passionate teams to build innovative cross-chain projects on Darwinia Chain. |
+| [Treasury Proposal](https://github.com/darwinia-network/collaboration/blob/master/treasury/README.md) | Your proposal should address a problem, outline a goal, give a detailed account of how you will reach that goal, and include any ongoing maintenance needs. As much as possible, you should itemize the tasks to be completed so fees can be evaluated and milestones can be followed. |
 
-  - **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.
+By participating in these programs, community developers can play a vital role in shaping the evolution and growth of the Darwinia ecosystem. We look forward to collaborating with talented developers like you to drive innovation and build a thriving community of decentralized applications.
diff --git a/docs/community/ringdao.md b/docs/community/ringdao.md
@@ -1,12 +1,8 @@
 # Overview
-RingDAO is a upcoming DAO based using Tally 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 Utilities of RING
+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).
 
-RING token is also used as the native and gas token of Darwinia Chain, it is also used for collator staking etc.
-
-## Other Projects governed by RingDAO
-
-  1. Msgport, https://docs.msgport.xyz/
-  2. XAPI, https://github.com/xapi-box
+## Other projects governed by RingDAO
 
+* [Msgport](https://docs.msgport.xyz/) 
+* [XAPI](https://github.com/xapi-box)
diff --git a/docs/learn/collator-staking.md b/docs/learn/collator-staking.md
@@ -1,10 +1,13 @@
 # Overview
-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](https://collator-staking.darwinia.network/) is used to 
 
+!!! note
+    The information about the upcoming implementation of Collator Staking DIPs will be updated in this article once those changes are implemented.
+
+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
 
-If you want to learn how to interact with these Collator Staking Precompile contracts, pleast vist the [precompile detail page](./ethereum-compatibility/precompiles/staking.md), be aware that this contract may be deprecated in future versions.
+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.
 
 ### **Parameters**
 The parameters to be aware of when understanding the darwinia staking module are as follows:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -184,7 +184,6 @@ nav:
           - Running a Development Node: "build/chain/run-dev-node.md"
   - Community:
       - Overview: "community/overview.md"
-      - Collaboration: "community/collaboration.md"
       - RingDAO: "community/ringdao.md"
       - DCDAO: "community/dcdao.md"
       - KtonDAO: "community/ktondao.md"