diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index b4e2c3fa2..ce9491cb9 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -14,6 +14,7 @@ module.exports = { title: "Introduction", collapsable: false, children: [ + "/introduction/", "/introduction/quick-start", "/introduction/install", "/introduction/what-is-tendermint" @@ -23,6 +24,7 @@ module.exports = { title: "Tendermint Core", collapsable: false, children: [ + "/tendermint-core/", "/tendermint-core/using-tendermint", "/tendermint-core/configuration", "/tendermint-core/rpc", @@ -40,14 +42,16 @@ module.exports = { title: "Tools", collapsable: false, children: [ - "tools/benchmarking", - "tools/monitoring" + "/tools/", + "/tools/benchmarking", + "/tools/monitoring" ] }, { title: "Networks", collapsable: false, children: [ + "/networks/", "/networks/docker-compose", "/networks/terraform-and-ansible", ] @@ -99,7 +103,7 @@ module.exports = { ] }, { - title: "ABCI Specification", + title: "ABCI Spec", collapsable: false, children: [ "/spec/abci/abci", diff --git a/docs/app-dev/getting-started.md b/docs/app-dev/getting-started.md index 066deaacd..14aa0dc30 100644 --- a/docs/app-dev/getting-started.md +++ b/docs/app-dev/getting-started.md @@ -7,8 +7,7 @@ application you want to run. So, to run a complete blockchain that does something useful, you must start two programs: one is Tendermint Core, the other is your application, which can be written in any programming language. Recall from [the intro to -ABCI](../introduction/introduction.html#abci-overview) that Tendermint Core handles all -the p2p and consensus stuff, and just forwards transactions to the +ABCI](../introduction/what-is-tendermint.md#abci-overview) that Tendermint Core handles all the p2p and consensus stuff, and just forwards transactions to the application when they need to be validated, or when they're ready to be committed to a block. diff --git a/docs/app-dev/subscribing-to-events-via-websocket.md b/docs/app-dev/subscribing-to-events-via-websocket.md index 69ab59f50..499548094 100644 --- a/docs/app-dev/subscribing-to-events-via-websocket.md +++ b/docs/app-dev/subscribing-to-events-via-websocket.md @@ -20,7 +20,7 @@ method via Websocket. } ``` -Check out [API docs](https://tendermint.github.io/slate/#subscribe) for +Check out [API docs](https://tendermint.com/rpc/) for more information on query syntax and other options. You can also use tags, given you had included them into DeliverTx @@ -32,7 +32,7 @@ transactions](./indexing-transactions.md) for details. When validator set changes, ValidatorSetUpdates event is published. The event carries a list of pubkey/power pairs. The list is the same Tendermint receives from ABCI application (see [EndBlock -section](https://tendermint.com/docs/app-dev/abci-spec.html#endblock) in +section](../spec/abci/abci.md#endblock) in the ABCI spec). Response: diff --git a/docs/introduction/README.md b/docs/introduction/README.md index ad9a93dd9..7f3f97a27 100644 --- a/docs/introduction/README.md +++ b/docs/introduction/README.md @@ -1,15 +1,15 @@ -# Introduction +# Overview ## Quick Start -Get Tendermint up-and-running quickly with the [quick-start guide](quick-start.md)! +Get Tendermint up-and-running quickly with the [quick-start guide](./quick-start.md)! ## Install -Detailed [installation instructions](install.md). +Detailed [installation instructions](./install.md). ## What is Tendermint? -Dive into [what Tendermint is and why](what-is-tendermint.md)! +Dive into [what Tendermint is and why](./what-is-tendermint.md)! diff --git a/docs/networks/README.md b/docs/networks/README.md index b1ba27126..aa53afb08 100644 --- a/docs/networks/README.md +++ b/docs/networks/README.md @@ -1,9 +1,9 @@ -# Networks +# Overview -Use [Docker Compose](docker-compose.md) to spin up Tendermint testnets on your +Use [Docker Compose](./docker-compose.md) to spin up Tendermint testnets on your local machine. -Use [Terraform and Ansible](terraform-and-ansible.md) to deploy Tendermint +Use [Terraform and Ansible](./terraform-and-ansible.md) to deploy Tendermint testnets to the cloud. See the `tendermint testnet --help` command for more help initializing testnets. diff --git a/docs/spec/consensus/consensus.md b/docs/spec/consensus/consensus.md index b58184c7a..acd07397a 100644 --- a/docs/spec/consensus/consensus.md +++ b/docs/spec/consensus/consensus.md @@ -241,7 +241,7 @@ commit-set) are each justified in the JSet with no duplicitous vote signatures (by the committers). - **Lemma**: When a fork is detected by the existence of two - conflicting [commits](./validators.html#commiting-a-block), the + conflicting [commits](../blockchain/blockchain.md#commit), the union of the JSets for both commits (if they can be compiled) must include double-signing by at least 1/3+ of the validator set. **Proof**: The commit cannot be at the same round, because that diff --git a/docs/tendermint-core/README.md b/docs/tendermint-core/README.md index 7f5dc6772..88228a581 100644 --- a/docs/tendermint-core/README.md +++ b/docs/tendermint-core/README.md @@ -1,4 +1,4 @@ -# Tendermint Core +# Overview See the side-bar for details on the various features of Tendermint Core. diff --git a/docs/tools/README.md b/docs/tools/README.md index b08416bb3..ef1ae7c22 100644 --- a/docs/tools/README.md +++ b/docs/tools/README.md @@ -1,4 +1,4 @@ -# Tools +# Overview -Tendermint comes with some tools for [benchmarking](benchmarking.md) -and [monitoring](monitoring.md). +Tendermint comes with some tools for [benchmarking](./benchmarking.md) +and [monitoring](./monitoring.md).