Browse Source

update docs links & sidebar (#2541)

* docs: fix links

* docs: add readme from each section to the sidebar
pull/2544/head
Zach 6 years ago
committed by Ethan Buchman
parent
commit
303649818c
8 changed files with 22 additions and 19 deletions
  1. +7
    -3
      docs/.vuepress/config.js
  2. +1
    -2
      docs/app-dev/getting-started.md
  3. +2
    -2
      docs/app-dev/subscribing-to-events-via-websocket.md
  4. +4
    -4
      docs/introduction/README.md
  5. +3
    -3
      docs/networks/README.md
  6. +1
    -1
      docs/spec/consensus/consensus.md
  7. +1
    -1
      docs/tendermint-core/README.md
  8. +3
    -3
      docs/tools/README.md

+ 7
- 3
docs/.vuepress/config.js View File

@ -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",


+ 1
- 2
docs/app-dev/getting-started.md View File

@ -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.


+ 2
- 2
docs/app-dev/subscribing-to-events-via-websocket.md View File

@ -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:


+ 4
- 4
docs/introduction/README.md View File

@ -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)!

+ 3
- 3
docs/networks/README.md View File

@ -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.

+ 1
- 1
docs/spec/consensus/consensus.md View File

@ -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


+ 1
- 1
docs/tendermint-core/README.md View File

@ -1,4 +1,4 @@
# Tendermint Core
# Overview
See the side-bar for details on the various features of Tendermint Core.

+ 3
- 3
docs/tools/README.md View File

@ -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).

Loading…
Cancel
Save