diff options
author | Wei-Ning Huang <w@dexon.org> | 2019-04-09 21:53:23 +0800 |
---|---|---|
committer | Wei-Ning Huang <w@dexon.org> | 2019-04-09 21:56:59 +0800 |
commit | 7ce1bf5922908f20b0e9078b0c3d4e6d293833b4 (patch) | |
tree | c4dc352e41593e16b95727839f2c9f035ae90e6a | |
parent | f1ed6d00aaf38f30a16c25cf6919e1f7a05f6659 (diff) | |
download | dexon-wiki-7ce1bf5922908f20b0e9078b0c3d4e6d293833b4.tar.gz dexon-wiki-7ce1bf5922908f20b0e9078b0c3d4e6d293833b4.tar.zst dexon-wiki-7ce1bf5922908f20b0e9078b0c3d4e6d293833b4.zip |
Update format to meet mdbook
-rw-r--r-- | API.md | 1 | ||||
-rw-r--r-- | Consensus-Algo-v2-Spec.md | 1 | ||||
-rw-r--r-- | Create-Wallet.md | 1 | ||||
-rw-r--r-- | DApp-Dev-Guide.md | 1 | ||||
-rw-r--r-- | DEXON-PAPERS.md | 1 | ||||
-rw-r--r-- | DEXON-RPC-Node-Operation-Guide.md | 1 | ||||
-rw-r--r-- | Fullnode-Dev-Guide.md | 1 | ||||
-rw-r--r-- | Fullnode-Development.md | 1 | ||||
-rw-r--r-- | Getting-Started.md | 1 | ||||
-rw-r--r-- | Network-Access-Guide.md | 1 | ||||
-rw-r--r-- | Node-OP-Guide.md | 1 | ||||
-rw-r--r-- | README.md | 27 | ||||
-rw-r--r-- | Resource.md | 1 | ||||
-rw-r--r-- | SUMMARY.md | 102 | ||||
-rw-r--r-- | System-Spec.md | 1 | ||||
-rw-r--r-- | Tech-Docs.md | 1 | ||||
-rw-r--r-- | accounts.md | 1 | ||||
-rw-r--r-- | block.md | 1 | ||||
-rw-r--r-- | data-api.md | 1 | ||||
-rw-r--r-- | how-to-use-this-documentation.md | 1 | ||||
-rw-r--r-- | overview.md | 26 | ||||
-rw-r--r-- | rpc-api.md | 1 | ||||
-rw-r--r-- | transaction.md | 1 | ||||
-rw-r--r-- | websocket-api.md | 1 |
24 files changed, 93 insertions, 83 deletions
@@ -0,0 +1 @@ +# API diff --git a/Consensus-Algo-v2-Spec.md b/Consensus-Algo-v2-Spec.md new file mode 100644 index 0000000..d1b9bfa --- /dev/null +++ b/Consensus-Algo-v2-Spec.md @@ -0,0 +1 @@ +# Consensus Algorithm V2 Specification diff --git a/Create-Wallet.md b/Create-Wallet.md new file mode 100644 index 0000000..68f4a38 --- /dev/null +++ b/Create-Wallet.md @@ -0,0 +1 @@ +# Create Wallet diff --git a/DApp-Dev-Guide.md b/DApp-Dev-Guide.md new file mode 100644 index 0000000..d2828c5 --- /dev/null +++ b/DApp-Dev-Guide.md @@ -0,0 +1 @@ +# DApp Development Guide diff --git a/DEXON-PAPERS.md b/DEXON-PAPERS.md new file mode 100644 index 0000000..ac4fba8 --- /dev/null +++ b/DEXON-PAPERS.md @@ -0,0 +1 @@ +# DEXON papers diff --git a/DEXON-RPC-Node-Operation-Guide.md b/DEXON-RPC-Node-Operation-Guide.md new file mode 100644 index 0000000..8438159 --- /dev/null +++ b/DEXON-RPC-Node-Operation-Guide.md @@ -0,0 +1 @@ +# Running a RPC node diff --git a/Fullnode-Dev-Guide.md b/Fullnode-Dev-Guide.md new file mode 100644 index 0000000..fce1fbf --- /dev/null +++ b/Fullnode-Dev-Guide.md @@ -0,0 +1 @@ +# Fullnode Development Guide diff --git a/Fullnode-Development.md b/Fullnode-Development.md new file mode 100644 index 0000000..7b85604 --- /dev/null +++ b/Fullnode-Development.md @@ -0,0 +1 @@ +# Contribute to DEXON Fullnode diff --git a/Getting-Started.md b/Getting-Started.md new file mode 100644 index 0000000..bad5562 --- /dev/null +++ b/Getting-Started.md @@ -0,0 +1 @@ +# Getting Started diff --git a/Network-Access-Guide.md b/Network-Access-Guide.md new file mode 100644 index 0000000..e2ae075 --- /dev/null +++ b/Network-Access-Guide.md @@ -0,0 +1 @@ +# Network Access Guide diff --git a/Node-OP-Guide.md b/Node-OP-Guide.md new file mode 100644 index 0000000..ee2778b --- /dev/null +++ b/Node-OP-Guide.md @@ -0,0 +1 @@ +# Node Operator Guide @@ -1,26 +1 @@ -# Introduction - -This documentation shows your way around [DEXON](https://dexon.org), the next generation blockchain platform. - -## Accessing DEXON Network - -To create a DEXON wallet and start using DEXON blockchain platform, follow [wallet creation guide](Create-Wallet.md). - -## DApp Development - -- To learn abour DApp (decentralized apps) development and build DApps on DEXON, follow [DApp development guide](Dapp-Development.md). -- If you have already developed DApps on Ethereum and is planning to move your existing DApp onto DEXON, check out [DEXON DApp deployment guide](). - -## Node Operation - -- To run a BP (block producing) full-node, follow [BP node operation guide](DEXON-BP-Node-Operation-Guide.md). -- To run a BP (block producing) full-node on testnet, follow [Testnet BP node operation guide](DEXON-BP-Node-Operation-Guide.md) -- If you simply need to communicate to DEXON network, like sending transactions or looking up network state, follow [RPC node operation guide](DEXON-RPC-Node-Operation-Guide.md). - -## Fullnode Development - -You can contribute to the development of DEXON itself! Get started with [DEXON fullnode development guide](Fullnode-Development.md). - -## Technical Documentations - -To learn more about how DEXON works, check out our [technical documenations](Technical-Documentations.md) +# Getting Started diff --git a/Resource.md b/Resource.md new file mode 100644 index 0000000..81dcb9f --- /dev/null +++ b/Resource.md @@ -0,0 +1 @@ +# Resource @@ -1,57 +1,45 @@ -## Introduction - -* [How to use this documentation](how-to-use-this-documentation.md) -* [Getting Started](README.md) -* [Overview](overview.md) - -# For development - -## Network Access Guide - -* [Create Wallet](Create-Wallet.md) - -## DApp Development Guide - -* [DApp Development](Dapp-Development.md) -* [Access to Testnet](Access-to-Testnet.md) - -## System Spec - -* [Accounts](accounts.md) -* [Transaction](transaction.md) -* [Block](block.md) - -## API - -* [JSON-RPC API](rpc-api.md) -* [WebSocket API](websocket-api.md) -* [DATA API](data-api.md) - -# For miner - -## Node Operator Guide - -* [Running a testnet BP node](Running--a-BP-node-for-Testnet.md) -* [Running a BP node](DEXON-BP-Node-Operation-Guide.md) -* [Running a RPC node](DEXON-RPC-Node-Operation-Guide.md) -* [Rule for the DEXON node set](Rule-for-the-DEXON-node-set.md) - -## Fullnode Development Guide - -* [Contribute to DEXON Fullnode](Fullnode-Development.md) -* [List of Repositories](List-of-Repositories.md) - -# Technical Documentations - -* [Consensus Algorithm V2 Specification](Consensus-Algo-v2-Spec.md) -* [Selection of notary set size](Selection-of-the-notary-set-size.md) -* [DKG-Tsig Protocol](DKG-TSIG-Protocol.md) -* [On-chain Random Oracle](On-Chain-Random-Oracle.md) -* [DEXON Cryptoeconomics](DEXON-Cryptoeconomics.md) -* [Governance Contract Interface](Governance-Contract-Interface.md) -* [Configuration Change](Configuration-Change.md) - -## Resource - -* [Blockchain Comparision](Blockchain-Comparison.md) -* [DEXON papers](DEXON-PAPERS.md)
\ No newline at end of file +# SUMMARY + +- [Getting Started](Getting-Started.md) + - [Overview](Overview.md) + - [How to use this documentation](how-to-use-this-documentation.md) + +- [Network Access Guide](Network-Access-Guide.md) + - [Create Wallet](Create-Wallet.md) + +- [DApp Development Guide](DApp-Dev-Guide.md) + - [DApp Development](Dapp-Development.md) + - [Access to Testnet](Access-to-Testnet.md) + +- [System Spec](System-Spec.md) + - [Accounts](accounts.md) + - [Transaction](transaction.md) + - [Block](block.md) + +- [API](API.md) + - [JSON-RPC API](rpc-api.md) + - [WebSocket API](websocket-api.md) + - [DATA API](data-api.md) + +- [Node Operator Guide](Node-OP-Guide.md) + - [Running a testnet BP node](Running--a-BP-node-for-Testnet.md) + - [Running a BP node](DEXON-BP-Node-Operation-Guide.md) + - [Running a RPC node](DEXON-RPC-Node-Operation-Guide.md) + - [Rule for the DEXON node set](Rule-for-the-DEXON-node-set.md) + +- [Fullnode Development Guide](Fullnode-Dev-Guide.md) + - [Contribute to DEXON Fullnode](Fullnode-Development.md) + - [List of Repositories](List-of-Repositories.md) + +- [Technical Documentations](Tech-Docs.md) + - [Consensus Algorithm V2 Specification](Consensus-Algo-v2-Spec.md) + - [Selection of notary set size](Selection-of-the-notary-set-size.md) + - [DKG-Tsig Protocol](DKG-TSIG-Protocol.md) + - [On-chain Random Oracle](On-Chain-Random-Oracle.md) + - [DEXON Cryptoeconomics](DEXON-Cryptoeconomics.md) + - [Governance Contract Interface](Governance-Contract-Interface.md) + - [Configuration Change](Configuration-Change.md) + +- [Resource](Resource.md) + - [Blockchain Comparision](Blockchain-Comparison.md) + - [DEXON papers](DEXON-PAPERS.md) diff --git a/System-Spec.md b/System-Spec.md new file mode 100644 index 0000000..c1a13ed --- /dev/null +++ b/System-Spec.md @@ -0,0 +1 @@ +# System Spec diff --git a/Tech-Docs.md b/Tech-Docs.md new file mode 100644 index 0000000..004a5b6 --- /dev/null +++ b/Tech-Docs.md @@ -0,0 +1 @@ +# Technical Documentations diff --git a/accounts.md b/accounts.md new file mode 100644 index 0000000..5b6def5 --- /dev/null +++ b/accounts.md @@ -0,0 +1 @@ +# Accounts diff --git a/block.md b/block.md new file mode 100644 index 0000000..2d45d23 --- /dev/null +++ b/block.md @@ -0,0 +1 @@ +# Block diff --git a/data-api.md b/data-api.md new file mode 100644 index 0000000..105cd0e --- /dev/null +++ b/data-api.md @@ -0,0 +1 @@ +# DATA API diff --git a/how-to-use-this-documentation.md b/how-to-use-this-documentation.md new file mode 100644 index 0000000..f0e4841 --- /dev/null +++ b/how-to-use-this-documentation.md @@ -0,0 +1 @@ +# How to use this documentation diff --git a/overview.md b/overview.md new file mode 100644 index 0000000..573dcaa --- /dev/null +++ b/overview.md @@ -0,0 +1,26 @@ +# Introduction + +This documentation shows your way around [DEXON](https://dexon.org), the next generation blockchain platform. + +## Accessing DEXON Network + +To create a DEXON wallet and start using DEXON blockchain platform, follow [wallet creation guide](Create-Wallet.md). + +## DApp Development + +- To learn abour DApp (decentralized apps) development and build DApps on DEXON, follow [DApp development guide](Dapp-Development.md). +- If you have already developed DApps on Ethereum and is planning to move your existing DApp onto DEXON, check out [DEXON DApp deployment guide](). + +## Node Operation + +- To run a BP (block producing) full-node, follow [BP node operation guide](DEXON-BP-Node-Operation-Guide.md). +- To run a BP (block producing) full-node on testnet, follow [Testnet BP node operation guide](DEXON-BP-Node-Operation-Guide.md) +- If you simply need to communicate to DEXON network, like sending transactions or looking up network state, follow [RPC node operation guide](DEXON-RPC-Node-Operation-Guide.md). + +## Fullnode Development + +You can contribute to the development of DEXON itself! Get started with [DEXON fullnode development guide](Fullnode-Development.md). + +## Technical Documentations + +To learn more about how DEXON works, check out our [technical documenations](Technical-Documentations.md) diff --git a/rpc-api.md b/rpc-api.md new file mode 100644 index 0000000..a4ce95e --- /dev/null +++ b/rpc-api.md @@ -0,0 +1 @@ +# JSON-RPC API diff --git a/transaction.md b/transaction.md new file mode 100644 index 0000000..13ebed4 --- /dev/null +++ b/transaction.md @@ -0,0 +1 @@ +# Transaction diff --git a/websocket-api.md b/websocket-api.md new file mode 100644 index 0000000..a6e1a03 --- /dev/null +++ b/websocket-api.md @@ -0,0 +1 @@ +# WebSocket API |