chore(docs): add documentation structure for MetaChain (#90)

#### What this PR does / why we need it: As per the title. Merely cosmetic change to move documentation structure into place. #### Which issue(s) does this PR fixes?:  Fixes part of #8
DeFiCh · Sep 14, 2022 · 20aba30 · 20aba30
1 parent 6586bc9
commit 20aba30
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 40 deletions.
diff --git a/docs/:000:index.md b/docs/:000:index.md
diff --git a/docs/:100:Specification/:010:rpc-interface.md b/docs/:100:Specification/:010:rpc-interface.md
diff --git a/docs/:100:Specification/:099:iterations.md b/docs/:100:Specification/:099:iterations.md
diff --git a/docs/:200:DeFiChain Basics/:100:what-is-metachain.md b/docs/:200:DeFiChain Basics/:100:what-is-metachain.md
@@ -0,0 +1,17 @@
+---
+title: What is MetaChain?
+---
+
+`DeFiCh/metachain` started as a codename research & development
+for [DFIP 2111-B: VOC: Ethereum Virtual Machine (EVM) Support](https://github.com/DeFiCh/dfips/issues/96). Proposed as a
+DFIP on Nov 2021; DFIP 2111-B provided DeFiChain with more flexibility to think beyond what is possible today. It
+introduced a new dimension to the DeFiChain ecosystem, allowing us to stretch the definition of Native DeFi.
+
+- Smart contract capability through a turing-complete environment for faster paced innovation
+- Embrace the multi-chain future enabling easier cross compatibility and extensibility.
+
+---
+
+:::div{class="admonitions red"}
+TODO
+:::
diff --git a/docs/:200:DeFiChain Basics/:110:what-is-nativechain.md b/docs/:200:DeFiChain Basics/:110:what-is-nativechain.md
@@ -0,0 +1,3 @@
+---
+title: What is NativeChain?
+---
diff --git a/docs/:200:DeFiChain Basics/:120:what-is-dfi.md b/docs/:200:DeFiChain Basics/:120:what-is-dfi.md
@@ -0,0 +1,3 @@
+---
+title: What is DFI?
+---
diff --git a/docs/:200:DeFiChain Basics/:500:wallet.md b/docs/:200:DeFiChain Basics/:500:wallet.md
@@ -0,0 +1,3 @@
+---
+title: DeFiChain Wallets
+---
diff --git a/docs/:300:MetaChain Protocol/:100:whitepaper.md b/docs/:300:MetaChain Protocol/:100:whitepaper.md
@@ -0,0 +1,3 @@
+---
+title: MetaChain Whitepaper
+---
diff --git a/docs/:300:MetaChain Protocol/:200:improvement-proposal.md b/docs/:300:MetaChain Protocol/:200:improvement-proposal.md
@@ -0,0 +1,3 @@
+---
+title: MetaChain Improvement Proposal
+---
diff --git a/docs/:300:MetaChain Protocol/:300:token-bridge.md b/docs/:300:MetaChain Protocol/:300:token-bridge.md
@@ -0,0 +1,3 @@
+---
+title: MetaChain Tokens & Bridge
+---
diff --git a/...0:Project Governance/:001:contributing.md → ...hain Governance/:001:code-contribution.md b/...0:Project Governance/:001:contributing.md → ...hain Governance/:001:code-contribution.md
@@ -1,5 +1,5 @@
 ---
-title: Contributing Guide
+title: Contributing Code
 ---
 
 Thanks for contributing, appreciate all the help we can get. Feel free to make a pull-request, we will guide you along
@@ -72,7 +72,7 @@ In `./packages/*`, it contains E2E test and packages for using and building on D
 pnpm install
 ```
 
-### pnpm
+### Installing pnpm
 
 If you have the brew package manager installed, you can install pnpm using the following command `brew install pnpm`.
 Otherwise, you should use the [standalone script to install](https://pnpm.io/installation#using-a-standalone-script). It

diff --git a/...:Project Governance/:002:documentation.md → ...hain Governance/:002:docs-contribution.md b/...:Project Governance/:002:documentation.md → ...hain Governance/:002:docs-contribution.md
@@ -1,10 +1,10 @@
 ---
-title: Writing Documentation
+title: Contributing Documentation
 ---
 
-Powered by [BirthdayResearch/contented](https://contented.dev), `contented.js` allows prose/markdown to be developed
-within its contextual repository as micro-docs. Separating content generation from content presentation. Downstream
-(e.g. defichain.com) can pull structured prose and represent them however they like.  
+Powered by [BirthdayResearch/contented](https://contented.dev), `docs/contented.config.js` allows prose/markdown to be
+developed within its contextual repository as "micro-docs". Separating content generation from content presentation.
+Downstream(e.g. defichain.com) can pull structured prose and represent them however they like.  
 **Commit your documentation into the repository together with your code.**
 
 > Why micro-docs? Think of a modern web-app, it is commonly agreed among developers in this decade that organizing files
@@ -14,7 +14,7 @@ within its contextual repository as micro-docs. Separating content generation fr
 
 ---
 
-## Installing
+### Installing
 
 Optional! You can treat it like you are committing plain old markdown files. CI/CD are added into this repository, you
 can let the CI/CD compile and generate the preview for you.
@@ -24,27 +24,27 @@ pnpm install
 pnpm run write
 ```
 
-## Structuring your Markdown
+### Structuring your Markdown
 
 ```
 docs/
-├─ 01:Sections/
-│  ├─ 01:Sub Sections 1/*.md
-│  ├─ 02:Sub Sections 2/*.md
-│  ├─ 90:overview.md
-│  └─ 99:faq.md
+├─ :01:Sections/
+│  ├─ :01:Sub Sections 1/*.md
+│  ├─ :02:Sub Sections 2/*.md
+│  ├─ :90:overview.md
+│  └─ :99:faq.md
 ├─ .gitignore
 ├─ contented.js
 ├─ package.json
 └─ package-lock.json
 ```
 
 Files are ordered alphabetically, contented allows you to prefix your markdown file or directory with a number
-prefix (`[0-9]+:(.+).md`, e.g. `01:file.md`). With the number prefix set, you can control how your content are sorted.
+prefix (`:[0-9]+:(.+).md`, e.g. `:01:file.md`). With the number prefix set, you can control how your content are sorted.
 
-## Supported Features
+### Supported Features
 
-[contented.dev/markdown](https://contented.dev/markdown)
+See [contented.dev/markdown](https://contented.dev/markdown)
 
 ### Frontmatter
 

diff --git a/docs/:900:MetaChain Governance/:200:node-upgrades.md b/docs/:900:MetaChain Governance/:200:node-upgrades.md
@@ -0,0 +1,3 @@
+---
+title: MetaChain Node Upgrades
+---