From b46da19b74142e9c4bc1a9724c0b5503035a0a0b Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Sat, 16 Sep 2017 15:19:22 -0400 Subject: [PATCH] docs: organize the directory, #656 --- docs/app-architecture.rst | 2 +- docs/specification.rst | 22 +++++++++---------- docs/{ => specification}/block-structure.rst | 0 .../byzantine-consensus-algorithm.rst | 0 docs/{ => specification}/configuration.rst | 0 docs/{ => specification}/fast-sync.rst | 0 docs/{ => specification}/genesis.rst | 0 .../light-client-protocol.rst | 2 +- docs/{ => specification}/merkle.rst | 0 docs/{ => specification}/rpc.rst | 0 docs/{ => specification}/secure-p2p.rst | 0 docs/{ => specification}/validators.rst | 0 docs/{ => specification}/wire-protocol.rst | 0 docs/using-tendermint.rst | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) rename docs/{ => specification}/block-structure.rst (100%) rename docs/{ => specification}/byzantine-consensus-algorithm.rst (100%) rename docs/{ => specification}/configuration.rst (100%) rename docs/{ => specification}/fast-sync.rst (100%) rename docs/{ => specification}/genesis.rst (100%) rename docs/{ => specification}/light-client-protocol.rst (97%) rename docs/{ => specification}/merkle.rst (100%) rename docs/{ => specification}/rpc.rst (100%) rename docs/{ => specification}/secure-p2p.rst (100%) rename docs/{ => specification}/validators.rst (100%) rename docs/{ => specification}/wire-protocol.rst (100%) diff --git a/docs/app-architecture.rst b/docs/app-architecture.rst index 5a8287f37..e7a0d0e74 100644 --- a/docs/app-architecture.rst +++ b/docs/app-architecture.rst @@ -58,7 +58,7 @@ Tendermint Core RPC The concept is that the ABCI app is completely hidden from the outside world and only communicated through a tested and secured `interface -exposed by the tendermint core <./rpc.html>`__. This interface +exposed by the tendermint core <./specification/rpc.html>`__. This interface exposes a lot of data on the block header and consensus process, which is quite useful for externally verifying the system. It also includes 3(!) methods to broadcast a transaction (propose it for the blockchain, diff --git a/docs/specification.rst b/docs/specification.rst index 02d84c343..2e8b35668 100644 --- a/docs/specification.rst +++ b/docs/specification.rst @@ -7,14 +7,14 @@ Here you'll find details of the Tendermint specification. See `the spec repo `__ where the commit includes a majority of signatures from the last known validator set. From there, all the application state is verifiable with `merkle -proofs <./merkle-trees#iavl-tree>`__. +proofs <./merkle.html#iavl-tree>`__. Properties ---------- diff --git a/docs/merkle.rst b/docs/specification/merkle.rst similarity index 100% rename from docs/merkle.rst rename to docs/specification/merkle.rst diff --git a/docs/rpc.rst b/docs/specification/rpc.rst similarity index 100% rename from docs/rpc.rst rename to docs/specification/rpc.rst diff --git a/docs/secure-p2p.rst b/docs/specification/secure-p2p.rst similarity index 100% rename from docs/secure-p2p.rst rename to docs/specification/secure-p2p.rst diff --git a/docs/validators.rst b/docs/specification/validators.rst similarity index 100% rename from docs/validators.rst rename to docs/specification/validators.rst diff --git a/docs/wire-protocol.rst b/docs/specification/wire-protocol.rst similarity index 100% rename from docs/wire-protocol.rst rename to docs/specification/wire-protocol.rst diff --git a/docs/using-tendermint.rst b/docs/using-tendermint.rst index 0d17db611..fb9882f6b 100644 --- a/docs/using-tendermint.rst +++ b/docs/using-tendermint.rst @@ -117,7 +117,7 @@ Configuration ------------- Tendermint uses a ``config.toml`` for configutation. For details, see -`the documentation <./configuration.html>`__. +`the documentation <./specification/configuration.html>`__. Notable options include the socket address of the application (``proxy_app``), the listenting address of the tendermint peer