From 555b61e3ae943752b1737ef5d168b5de31b940ef Mon Sep 17 00:00:00 2001 From: Zach Date: Wed, 14 Nov 2018 17:32:41 -0500 Subject: [PATCH] deleted obsolete file (#2817) --- docs/.vuepress/config.js | 12 ++++----- docs/README.md | 6 ++++- docs/_attic/node.md | 45 ------------------------------- docs/clients/lite/readme.md | 2 +- docs/clients/service-providers.md | 2 +- 5 files changed, 13 insertions(+), 54 deletions(-) delete mode 100644 docs/_attic/node.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 0774208ab446..c4710379e0ca 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -15,7 +15,7 @@ module.exports = { title: "Overview", collapsable: false, children: [ - "/intro/README", + "/intro/", "/intro/sdk-app-architecture", "/intro/ocap" ] @@ -38,12 +38,12 @@ module.exports = { title: "Clients", collapsable: false, children: [ - "/clients/README", - "/lite/", // this renders the readme - "/lite/getting_started", - "/lite/specification", + "/clients/", "/clients/cli", - "/clients/service-providers" + "/clients/service-providers", + "/clients/lite/", // this renders the readme + "/clients/lite/getting_started", + "/clients/lite/specification" ] } ] diff --git a/docs/README.md b/docs/README.md index fbdf89797bef..048f9f39f231 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,7 +32,11 @@ If you are reading this on the Cosmos Website, please know that you can find mor To install the latest version of the `gaia` application and join the public testnet, **click [here](./gaia/README.md#join-the-cosmos-hub-public-testnet)** -## Edit the Documentation +## Contribute See [this file](./DOCS_README.md) for details of the build process and considerations when making changes. + +## Version + +This documentation is built from the following commit: diff --git a/docs/_attic/node.md b/docs/_attic/node.md deleted file mode 100644 index fb3ff07b1595..000000000000 --- a/docs/_attic/node.md +++ /dev/null @@ -1,45 +0,0 @@ -# Running a Node - -> TODO: Improve documentation of `gaiad` - - -## Basics - -To start a node: - -```shell -$ gaiad start -``` - -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. - -## Debugging - -Optionally, you can run `gaiad` with `--trace-store` to trace all store operations -to a specified file. - -```shell -$ gaiad start --trace-store=/path/to/trace.out -``` - -Key/value pairs will be base64 encoded. Additionally, the block number and any -correlated transaction hash will be included as metadata. - -e.g. -```json -... -{"operation":"write","key":"ATW6Bu997eeuUeRBwv1EPGvXRfPR","value":"BggEEBYgFg==","metadata":{"blockHeight":12,"txHash":"5AAC197EC45E6C5DE0798C4A4E2F54BBB695CA9E"}} -{"operation":"write","key":"AjW6Bu997eeuUeRBwv1EPGvXRfPRCgAAAAAAAAA=","value":"AQE=","metadata":{"blockHeight":12,"txHash":"5AAC197EC45E6C5DE0798C4A4E2F54BBB695CA9E"}} -{"operation":"read","key":"ATW6Bu997eeuUeRBwv1EPGvXRfPR","value":"BggEEBYgFg==","metadata":{"blockHeight":13}} -{"operation":"read","key":"AjW6Bu997eeuUeRBwv1EPGvXRfPRCwAAAAAAAAA=","value":"","metadata":{"blockHeight":13}} -... -``` - -You can then query for the various traced operations using a tool like [jq](https://github.com/stedolan/jq). - -```shell -$ jq -s '.[] | select((.key=="ATW6Bu997eeuUeRBwv1EPGvXRfPR") and .metadata.blockHeight==14)' /path/to/trace.out -``` \ No newline at end of file diff --git a/docs/clients/lite/readme.md b/docs/clients/lite/readme.md index 3811f3c3eeab..e7b57deedc16 100644 --- a/docs/clients/lite/readme.md +++ b/docs/clients/lite/readme.md @@ -1,4 +1,4 @@ -# Overview +# Lite Client Overview **See the Cosmos SDK lite Client RPC documentation [here](https://cosmos.network/rpc/)** diff --git a/docs/clients/service-providers.md b/docs/clients/service-providers.md index b7e6d500cb01..358031b966f4 100644 --- a/docs/clients/service-providers.md +++ b/docs/clients/service-providers.md @@ -1,4 +1,4 @@ -# Integrate a Cosmos-SDK based blockchain as a Service Provider +# Service Providers We define 'service providers' as entities providing services for end-users that involve some form of interaction with a Cosmos-SDK based blockchain (this includes the Cosmos Hub). More specifically, this document will be focused around interactions with tokens.