metachain icon indicating copy to clipboard operation
metachain copied to clipboard

Documenting Meta Chain: `docs/**.md`

Open fuxingloh opened this issue 2 years ago • 5 comments

Setup an open-source documentation website on “DeFiCh/metachain” to have a clear source of truth for DMC engineering resources. (E.g., whitepaper, discussions, concepts, etc.)

Please append your name for parts you wish to work on.

Project

DeFiChain Basics

We should outline the inception story, timeline, and how we got here. And where we're going story.

  • [ ] What is MetaChain?@kynkong91
  • [ ] What is NativeChain?@kynkong91
  • [ ] What is DFI? @kynkong91
  • [ ] DeFiChain Wallets @kynkong91

MetaChain Protocol

  • [ ] MetaChain Whitepaper @kynkong91
  • [ ] MetaChain Improvement Proposals? (MCIP: specific to MetaChain only, DFIP: is for the entire project.)
  • [x] MetaChain Consensus - #101
  • [x] MetaChain Tokens & Bridge - #102
  • [ ] MetaChain Node Upgrades @fuxingloh (talks about our release methodology and feature flagging design)

NativeChain Protocol

Should we include this?

MetaChain Governance:

Including but not limited to establishing the open-source governance “health files” to have clear and automated project governance.

  • [x] Contributing Code @fuxingloh
  • [x] Contributing Documentation @fuxingloh

Packages

Automatically generated from packages/*/README.md to build a content tree.

Meta

Automatically generated from meta/*/README.md to build a content tree.

fuxingloh avatar Jul 18 '22 06:07 fuxingloh

@fuxingloh: There are no 'area' labels on this issue. Adding an appropriate label will greatly expedite the process for us. You can add as many area as you see fit. If you are unsure what to do you can ignore this!

You can add area labels by leaving a /area comment.

Details

I am a bot created to help the DeFiCh developers manage community feedback and contributions. You can check out my manifest file to understand my behavior and what I can do. If you want to use this for your project, you can check out the BirthdayResearch/oss-governance-bot repository.

defichain-bot avatar Jul 18 '22 06:07 defichain-bot

  • [x] update to latest contented >=v1

fuxingloh avatar Jul 28 '22 06:07 fuxingloh

  • [x] We need to separate out root README.md and not mix docs/* with project README.md for this.
  • [x] Also move packages/docs -> to ./docs after merging #72

fuxingloh avatar Sep 08 '22 07:09 fuxingloh

We might want to include "MetaChain Consensus" to discuss how it works separately from MetaChain Whitepaper.

fuxingloh avatar Sep 14 '22 06:09 fuxingloh

We might want to include "MetaChain Consensus" to discuss how it works separately from MetaChain Whitepaper.

Included ^

MetaChain Whitepaper should also talk about the iterative plan of how DeFiChain ecosystem should evolve.

fuxingloh avatar Sep 14 '22 08:09 fuxingloh