From 4e87cdf4443fc4b16697eff993dac0626d44fcfb Mon Sep 17 00:00:00 2001 From: Ethan Buchman Date: Fri, 29 Jun 2018 01:59:52 -0400 Subject: [PATCH] add links for modules and clients --- docs/README.md | 14 ++++++------ docs/clients/cli.md | 6 +++++ docs/clients/keys.md | 6 +++++ docs/clients/node.md | 10 +++++++++ docs/clients/rest.md | 6 +++++ docs/modules/README.md | 51 ++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 86 insertions(+), 7 deletions(-) create mode 100644 docs/clients/cli.md create mode 100644 docs/clients/keys.md create mode 100644 docs/clients/node.md create mode 100644 docs/clients/rest.md create mode 100644 docs/modules/README.md diff --git a/docs/README.md b/docs/README.md index cf4494003a..f47fafa114 100644 --- a/docs/README.md +++ b/docs/README.md @@ -51,16 +51,16 @@ NOTE: This documentation is a work-in-progress! interfaces for clients to use! - [Modules](modules) - - [Bank](modules/bank.md) - - [Staking](modules/staking.md) - - [Slashing](modules/slashing.md) - - [Provisions](modules/provisions.md) - - [Governance](modules/governance.md) - - [IBC](modules/ibc.md) + - [Bank](modules/README.md#bank) + - [Staking](modules/README.md#stake) + - [Slashing](modules/README.md#slashing) + - [Provisions](modules/README.md#provisions) + - [Governance](modules/README.md#governance) + - [IBC](modules/README.md#ibc) - [Clients](clients) - [Running a Node](clients/node.md) - Run a full node! - [Key Management](clients/keys.md) - Managing user keys - [CLI](clients/cli.md) - Queries and transactions via command line - - [Light Client Daemon](clients/lcd.md) - Queries and transactions via REST + - [REST](clients/rest.md) - Queries and transactions via REST API diff --git a/docs/clients/cli.md b/docs/clients/cli.md new file mode 100644 index 0000000000..46490cad91 --- /dev/null +++ b/docs/clients/cli.md @@ -0,0 +1,6 @@ +# CLI + +See `gaiacli --help` for more details. + +Also see the [testnet +tutorial](https://github.com/cosmos/cosmos-sdk/tree/develop/cmd/gaia/testnets). diff --git a/docs/clients/keys.md b/docs/clients/keys.md new file mode 100644 index 0000000000..4b5a17cb3a --- /dev/null +++ b/docs/clients/keys.md @@ -0,0 +1,6 @@ +# Keys + +See `gaiacli keys --help`. + +Also see the [testnet +tutorial](https://github.com/cosmos/cosmos-sdk/tree/develop/cmd/gaia/testnets). diff --git a/docs/clients/node.md b/docs/clients/node.md new file mode 100644 index 0000000000..71d4846fd9 --- /dev/null +++ b/docs/clients/node.md @@ -0,0 +1,10 @@ +# Running a Node + +TODO: document `gaiad` + +Options for running the `gaiad` binary are effectively the same as for `tendermint`. +See `gaiad --help` and the +[guide to using Tendermint](https://github.com/tendermint/tendermint/blob/master/docs/using-tendermint.md) +for more details. + + diff --git a/docs/clients/rest.md b/docs/clients/rest.md new file mode 100644 index 0000000000..190eeb1f34 --- /dev/null +++ b/docs/clients/rest.md @@ -0,0 +1,6 @@ +# REST + +See `gaiacli advanced rest-server --help` for more. + +Also see the +[work in progress API specification](https://github.com/cosmos/cosmos-sdk/pull/1314) diff --git a/docs/modules/README.md b/docs/modules/README.md new file mode 100644 index 0000000000..53e02687ea --- /dev/null +++ b/docs/modules/README.md @@ -0,0 +1,51 @@ +# Bank + +The `x/bank` module is for transferring coins between accounts. + +See the [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/bank). + +# Stake + +The `x/stake` module is for Cosmos Delegated-Proof-of-Stake. + +See the [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/stake). + +See the +[specification](https://github.com/cosmos/cosmos-sdk/tree/develop/docs/spec/staking) + +# Slashing + +The `x/slashing` module is for Cosmos Delegated-Proof-of-Stake. + +See the [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/slashing) + +See the +[specification](https://github.com/cosmos/cosmos-sdk/tree/develop/docs/spec/slashing) + +# Provisions + +The `x/provisions` module is for distributing fees and inflation across bonded +stakeholders. + +See the [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/provisions) + +See the +[specification](https://github.com/cosmos/cosmos-sdk/tree/develop/docs/spec/provisions) + +# Governance + +The `x/gov` module is for bonded stakeholders to make proposals and vote on them. + +See the [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/gov) + +See the +[specification](https://github.com/cosmos/cosmos-sdk/tree/develop/docs/spec/governance) + +# IBC + +The `x/ibc` module is for InterBlockchain Communication. + +See the [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/ibc) + +See the +[specification](https://github.com/cosmos/cosmos-sdk/tree/develop/docs/spec/ibc)