Merge docs to develop

docs/.vuepress/config.js

@@ -1,55 +1,186 @@
 module.exports = {
-  title: 'IRISnet Document',
-  description: '',
-  base: "/docs/",
-  themeConfig: {
-    displayAllHeaders: false,
-    nav: [
-      { text: 'Back to IRISnet', link: 'https://www.irisnet.org' }
-    ],
-    sidebar: [
-      {
-        title: 'Introduction',
-        collapsable: false,
-        children: [
-          ['/introduction/Whitepaper.md', 'Whitepaper - English'],
-          ['/introduction/Whitepaper_CN.md', 'Whitepaper - 中文']
-        ]
-      },{
-        title: 'Getting Started',
-        collapsable: false,
-        children: [
-          ['/get-started/', 'Join the Testnet'],
-          ['/get-started/Install-Iris.md', 'Install'],
-          ['/get-started/Full-Node.md', 'Run a Full Node'],
-          ['/get-started/Validator-Node.md', 'Run a Validator Node'],
-          ['/get-started/Genesis-Generation-Process.md', 'Genesis Generation'],
-          ['/get-started/Bech32-on-IRISnet.md', 'Bech32 on IRISnet'],
-        ]
-      },{
-        title: 'Modules',
-        collapsable: false,
-        children: [
-          // ['/modules/coin/README.md', 'Coin Type'],
-          ['/modules/fee-token/', 'Fee Token']
-          // ['/modules/gov/README.md', 'Governance']
-        ]
-      },{
-        title: 'Tools',
-        collapsable: false,
-        children: [
-          ['/tools/Deploy-IRIS-Monitor.md', 'Monitor']
-        ]
-      },{
-        title: 'Validators',
-        collapsable: false,
-        children: [
-          ['/validators/', 'Overview'],
-          ['/validators/Setup-Sentry-Node.md', 'Sentry Node'],
-          ['/validators/How-to-participate-in-onchain-governance.md', 'Onchain Governance'],
-          ['/validators/FAQ.md', 'FAQ']
-        ]
-      }
-    ]
-  }
-}
+    title: 'IRISnet Document',
+    description: '',
+    base: "/docs/",
+    themeConfig: {
+        displayAllHeaders: false,
+        nav: [
+            {text: 'Back to IRISnet', link: 'https://www.irisnet.org'},
+            {text: 'Introduction', link: '/introduction/'},
+            {text: 'Software', link: '/software/'},
+            {text: 'Getting Started', link: '/get-started/'},
+            {text: 'Features', link: '/features/'},
+            {text: 'CLI Client', link: '/cli-client/'},
+            {text: 'Light Client', link: '/light-client/'},
+            {text: 'Resources', link: '/resources/'},
+        ],
+        sidebar: {
+            '/introduction/': [{
+                title: 'The IRIS Hub',
+                collapsable: false,
+                children: [
+                    'The-IRIS-Hub/Proof-of-Stake.md',
+                    'The-IRIS-Hub/IRIS-Tokens.md',
+                    'The-IRIS-Hub/Validators.md',
+                    'The-IRIS-Hub/Delegators.md'
+                ]
+            },
+                {
+                    title: 'The IRIS Service',
+                    collapsable: false,
+                    children: [
+                        'The-IRIS-Service/Lifecycle.md',
+                        'The-IRIS-Service/Providers.md',
+                        'The-IRIS-Service/Consumers.md',
+                    ]
+                },
+                {
+                    title: 'The IRIS Network',
+                    collapsable: false,
+                    children: [
+                        'The-IRIS-Network/'
+                    ]
+                }],
+            '/software/': [
+                {
+                title: 'Node',
+                collapsable: false,
+                children: [
+                    ['node.md', 'Node']
+                ]
+            }, {
+                title: 'CLI Client',
+                collapsable: false,
+                children: [
+                    ['cli-client.md', 'CLI Client']
+                ]
+            }, {
+                title: 'Light Client',
+                collapsable: false,
+                children: [
+                    ['light-client.md', 'Light Client']
+                ]
+            }, {
+                title: 'Monitor',
+                collapsable: false,
+                children: [
+                    ['monitor.md', 'Monitor']
+                ]
+            }],
+            '/get-started/': [{
+                title: 'Getting Started',
+                collapsable: false,
+                children: [
+                    ['Download-Rainbow.md', 'Download Rainbow'],
+                    ['Install-the-Software.md', 'Install the Software'],
+                    ['Join-the-Testnet.md', 'Join the Testnet']
+                ]
+            }],
+            '/features/': [{
+                title: 'Basic Concepts',
+                collapsable: false,
+                children: [
+                    ["basic-concepts/coin-type.md", 'Coin Type'],
+                    ["basic-concepts/fee.md", 'Fee'],
+                    ["basic-concepts/inflation.md", 'Infation'],
+                    ["basic-concepts/bech32-prefix.md", 'Bech32 Prefix'],
+                    ["basic-concepts/genesis-file.md", 'Genesis File'],
+                    ["basic-concepts/gov-params.md", 'Gov Params']
+                ]
+            },{
+                title: 'Modules',
+                collapsable: false,
+                children: [
+                    ['bank.md', 'Bank'],
+                    ['stake.md', 'Stake'],
+                    ['service.md', 'Service'],
+                    ['record.md', 'Record'],
+                    ['governance.md', 'Governance'],
+                    ['upgrade.md', 'Upgrade'],
+                    ['distribution.md', 'Distribution'],
+                ]
+            }],
+            '/cli-client/': [{
+                title: 'Status',
+                collapsable: false,
+                children: [
+                    ['status/', 'iriscli status']
+                ]
+            },
+                {
+                    title: 'Tendermint',
+                    collapsable: false,
+                    children: [
+                        ['tendermint/', 'iriscli tendermint']
+                    ]
+                },
+                {
+                    title: 'Keys',
+                    collapsable: false,
+                    children: [
+                        ['keys/', 'iriscli keys']
+                    ]
+                },
+                {
+                    title: 'Bank',
+                    collapsable: false,
+                    children: [
+                        ['bank/', 'iriscli bank']
+                    ]
+                },
+                {
+                    title: 'Stake',
+                    collapsable: false,
+                    children: [
+                        ['stake/', 'iriscli stake']
+                    ]
+                },
+                {
+                    title: 'Gov',
+                    collapsable: false,
+                    children: [
+                        ['gov/', 'iriscli gov']
+                    ]
+                },
+                {
+                    title: 'Record',
+                    collapsable: false,
+                    children: [
+                        ['record/', 'iriscli record']
+                    ]
+                },
+                {
+                    title: 'Upgrade',
+                    collapsable: false,
+                    children: [
+                        ['upgrade/', 'iriscli upgrade']
+                    ]
+                },
+                {
+                    title: 'Service',
+                    collapsable: false,
+                    children: [
+                        ['service/', 'iriscli service']
+                    ]
+                }],
+            '/light-client/': [{
+                title: 'Light Client',
+                collapsable: false,
+                children: [
+                    ['', 'Light Client']
+                ]
+            }],
+            '/resources/': [{
+                title: 'Resources',
+                collapsable: false,
+                children: [
+                    ['validator-faq.md', 'Validator FAQ'],
+                    ['delegator-faq.md', 'Delegator FAQ'],
+                    ['whitepaper-zh.md', 'Whitepaper ZH'],
+                    ['whitepaper-en.md', 'Whitepaper EN'],
+                    ['whitepaper-kr.md', 'Whitepaper KR'],
+                ]
+            }]
+        }
+    }
+}

docs/cli-client/README.md

@@ -0,0 +1,57 @@
+# Command Line Client
+
+## Global flags of query commands
+
+All query commands has these global flags. Their unique flags will be introduced later.
+
+| Name, shorthand | type   | Required | Default Value         | Description                                                          |
+| --------------- | ----   | -------- | --------------------- | -------------------------------------------------------------------- |
+| --chain-id      | string | false    | ""                    | Chain ID of tendermint node |
+| --height        | int    | false    | 0                     | Block height to query, omit to get most recent provable block |
+| --help, -h      | string | false    |                       | Print help message |
+| --indent        | bool   | false    | false                 | Add indent to JSON response |
+| --ledger        | bool   | false    | false                 | Use a connected Ledger device |
+| --node          | string | false    | tcp://localhost:26657 | \<host>:\<port> to tendermint rpc interface for this chain |
+| --trust-node    | bool   | false    | true                  | Don't verify proofs for responses |
+
+## Global flags of commands to send transactions
+
+All commands which can be used to send transactions have these global flags. Their unique flags will be introduced later.
+
+| Name, shorthand  | type   | Required | Default               | Description                                                         |
+| -----------------| -----  | -------- | --------------------- | ------------------------------------------------------------------- |
+| --account-number | int    | false    | 0                     | AccountNumber number to sign the tx |
+| --async          | bool   | false    | false                 | broadcast transactions asynchronously |
+| --chain-id       | string | true     | ""                    | Chain ID of tendermint node  |
+| --dry-run        | bool   | false    | false                 | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it |
+| --fee            | string | true     | ""                    | Fee to pay along with transaction |
+| --from           | string | false    | ""                    | Name of private key with which to sign |
+| --from-addr      | string | false    | ""                    | Specify from address in generate-only mode |
+| --gas            | int    | false    | 200000                | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically |
+| --gas-adjustment | int    | false    | 1                     | Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set |
+| --generate-only  | bool   | false    | false                 | Build an unsigned transaction and write it to STDOUT |
+| --help, -h       | string | false    |                       | Print help message |
+| --indent         | bool   | false    | false                 | Add indent to JSON response |
+| --json           | string | false    | false                 | Return output in json format |
+| --ledger         | bool   | false    | false                 | Use a connected Ledger device |
+| --memo           | string | false    | ""                    | Memo to send along with transaction |
+| --node           | string | false    | tcp://localhost:26657 | \<host>:\<port> to tendermint rpc interface for this chain |
+| --print-response | bool   | false    | false                 | return tx response (only works with async = false)|
+| --sequence int   | int    | false    | 0                     | Sequence number to sign the tx |
+| --trust-node     | bool   | false    | true                  | Don't verify proofs for responses | 
+
+## Modules list
+
+Each modules provides a set of command line interfaces. Here we sort these commands by modules.
+
+1. [bank command](./bank/README.md)
+2. [distribution command](./distribution/README.md)
+3. [gov command](./gov/README.md)
+4. [keys command](./keys/README.md)
+5. [lcd command](./lcd/README.md)
+6. [record command](./record/README.md)
+7. [service command](./service/README.md)
+8. [stake command](./stake/README.md)
+9. [status command](./status/README.md)
+10. [tendermint command](./tendermint/README.md)
+11. [upgrade command](./upgrade/README.md)

docs/cli-client/bank/README.md

@@ -0,0 +1 @@
+# iriscli 

docs/cli-client/distribution/README.md

@@ -0,0 +1,28 @@
+# iriscli distribution 
+
+## introduction
+
+This document describes how to use the the command line interfaces of distribution module.
+
+## Usage
+
+```
+iriscli distribution [subcommand] [flags]
+```
+
+Print all supported subcommands and flags:
+
+```
+iriscli distribution --help
+```
+
+## Available Subommands
+
+| Name                            | Description                                                   |
+| --------------------------------| --------------------------------------------------------------|
+| [delegation-distr-info](delegation-distr-info.md) | Query delegation distribution information |
+| [delegator-distr-info](delegator-distr-info.md) | Query delegator distribution information |
+| [validator-distr-info](validator-distr-info.md) | Query validator distribution information |
+| [withdraw-address](withdraw-address.md) | Query withdraw address |
+| [set-withdraw-address](set-withdraw-address.md)  | change the default withdraw address for rewards associated with an address |
+| [withdraw-rewards](withdraw-rewards.md) | withdraw rewards for either: all-delegations, a delegation, or a validator |

docs/cli-client/distribution/delegation-distr-info.md

@@ -0,0 +1,37 @@
+# iriscli distribution delegation-distr-info
+
+## introduction
+
+Query a delegation distribution information
+
+## Usage
+
+```
+iriscli distribution delegation-distr-info [flags]
+```
+
+Print help messages:
+```
+iriscli distribution delegation-distr-info --help
+```
+
+## Unique Flags
+
+| Name, shorthand     | type   | Required | Default  | Description                                                         |
+| --------------------| -----  | -------- | -------- | ------------------------------------------------------------------- |
+| --address-validator | string | true     | ""       | Bech address of the validator |
+| --address-delegator | string | true     | ""       | Bech address of the delegator |
+
+## Examples
+
+```
+iriscli distribution delegation-distr-info --address-delegator=<delegator address> --address-validator=<validator address>
+```
+Example response:
+```json
+{
+  "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j",
+  "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4",
+  "del_pool_withdrawal_height": "4044"
+}
+```