darwinia-network / darwinia-docs-deprecated

Darwinia Documentation

Darwinia Documentation

The Darwinia Documentation is a wiki style central source of documents for Darwinia Network. It is a community-focused initiative to keep an up-to-date resource on the best information of Darwinia Network.

Contributing to Documentation

The Wiki is a community-focused initiative and we will review all pull-requests and issues created in this repository. If you notice typos or grammatical errors, please feel free to directly create pull requests with these corrections. Larger contributions may start as issues to test the waters on the subject with the maintainers. It is generally preferable to create a pull request over an issue to propose a change to the wiki content.

Style Guide

• Break lines at 120 characters.
• Newlines between headers and text.
• No double line breaks.

Automated Deployments

The wiki is automatically deployed to GitHub Pages via the Travis job on each new commit to the master branch.

License The Darwinia Network is licensed under the GPL-3.0 free software license.

darwinia-docs-deprecated's Issues

中文：创建账户

crab-tut-create-account.md

Tutorial: Participate in governance

中文：成为验证人

Add Toolbox's rpc method to generate session key

https://docs.darwinia.network/docs/en/crab-tut-node#generate-session-key

Can use apps -> Toolbox -> Rpc ->author -> rotateKeys

This is easier way to operate.

中文：启动节点

中文：领取cRing从水龙头

crab-tut-claim-cring.md

Dup Docs

https://github.com/darwinia-network/docs/blob/master/content/zh-CN/dev-workshop-0002.md
https://github.com/darwinia-network/docs/blob/master/content/zh-CN/dev-workshop-0003.md

Uniform terminology

• RING 全部大写
• KTON 全部大写
• Crab RING: CRING, CRINGs
• Crab KTON: CKTON, CKTONs
• Subscan: Subscan
• Darwinia Network 首字大写
• Darwinia Crab Network 或者 Crab Network

English: Create an Account

crab-tut-create-account.md

Tutorial: Create an Account

Refactor content tree and structure.

Should split into different views for:

• General Users (Polkadot Apps{tokens, governance, staking etc.}, Bridge/Wormhole, Apps)
• Application(Smart contract) Developers (EVM & smart contract specificly)
• Protocol Developers (Protocol, RFC, Substrate)
• Validators and Bridgers.

The diagram in Architecture needs to be updated

wiki-us-bc-how is empty

Bridge Mechanism

Relayer Game

Tutorial: Get free cRing from faucet

Fix Knowledge Base link

Currently knowledge base is linked to https://docs.darwinia.network/docs/en/wiki-home

But the wiki contents located in
https://docs.darwinia.network/docs/en/wiki-intro

The are not connected.

Complete contributing guide and mastering markdown link

https://wiki.polkadot.network/docs/en/contributing Polkadot Wiki的这个Contributing Guide也可以参考和修改一下，加到我们的doc里面

https://guides.github.com/features/mastering-markdown/

Dvm tutorials in pangolin

Tasks

• Transfer PRing to evm address.
• Using metamask
• Using web3 for transaction, contract.

Generate Session Keys in Rc2

Workshop Index

Introduction about ChainReactions

• Chinese Overview
• English Overview

Engish: Claim cRing from Faucet

crab-tut-claim-cring.md

English: Participate in governance

crab-tut-governance.md

Boot from Toml File

Use Crowdin for translations

docusaurus supports crowdin well.

https://docusaurus.io/docs/en/translation#crowdin

Font optimization

1. Reduce display differences on different platforms
2. Font size adjustment

Add docker doc for running full nodes or validator nodes

Bridge Chain need more description

Doc: The nomination which are before the validator's recent slashing will be ignored.

nominator: 5HE1gjo5cRP5Xzf42zrc3gExws6zqrtnMsHTi3jZ5KbLpKnd
validator: 5HKSD4vd1GaM92Udj9NJ3rTSrrsjyFYvYBukAs2ZcuFtA5UX

Warning validators they should not run more than one validators in one client node

Only one validator in the client node can participate in grandpa gossip, others will fail.

Honest validators should not do this.

wp-home outdated

And the Darwinia focuses its major application in games and de-fi sector. is outdated

Crab Parameters

Confirm Crab Parameters

Crab 系列教程

Link Rust Doc

Keep the documents synchronized with the main online process

Main task

1. Update the finalized node binary download address of The Main Net.
2. Update docker command of running main net node.
3. Update switch net guide image of the main network

Dev Substrate page

• English
• Chinese

Improvement Checklist

• Appearance
  • how to view locally guide. Put it to README.md
  • #108 Font optimization
  • Better and more unified screenshots
  • Better and more unified content layout
• Content correctness
  • Expired content, either delete or update
  • Check the screenshot content, 1. Chinese or English, 2. Network, 3. Address format, etc.
• blog improvement
• link rfcs to https://rfcs.darwinia.network

Tutorial: Become a nominator

中文：参与治理

crab-tut-governance.md

author_rotateKeys need to use --rpc-methods Unsafe

https://wiki.polkadot.network/docs/en/maintain-guides-how-to-validate-polkadot#option-2-cli

English：Run node

Top column description optimization discussion

主网相关内容是否继续叫wiki？还是改成Darwinia Mainnet好一点

Refactor the part of session key generating.

There are some missing info for the rotateKeys in apps ui, and the session keys should be placed at https://docs.darwinia.network/docs/en/crab-tut-node#generate-session-key

Remind validator nodes to add --validator in validator docs.

DVM withdraw precompile input spec document

darwinia-network/darwinia-common#474

Bounty Program

Bounty Program page

• Chinese
• English

Generating and link reference rustdoc from darwinia code

Example:

https://substrate.dev/rustdocs/master/sc_service/index.html

Note:

Might need help from core developers @yanganto @clearloop

中文：成为投票人

crab-tut-nominator

Workshop Content Retouch

Detailed video/content for each workshop.

• Vol 1
• Vol 2
• Vol 3
• Vol 4
• Vol 5
• Vol 6
• Vol 7

English: Become a validator

English: Become a nominator

crab-tut-nominator