Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs cleanup #1800

Merged
merged 9 commits into from
Jun 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 23 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,28 @@
Here lies our documentation. After making edits, run:
# Tendermint

```
pip install -r requirements.txt
make html
```
Welcome to the Tendermint Core documentation! The introduction below provides
an overview to help you navigate to your area of interest.

to build the docs locally then open the file `_build/html/index.html` in your browser.
## Introduction

**WARNING:** This documentation is intended to be viewed at:
Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state
transition machine - written in any programming language - and securely
replicates it on many machines. In other words, a blockchain.

https://tendermint.readthedocs.io
Tendermint requires an application running over the Application Blockchain
Interface (ABCI) - and comes packaged with an example application to do so.
Follow the [installation instructions](./install) to get up and running
quickly. For more details on [using tendermint](./using-tendermint) see that
and the following sections.

and may contain broken internal links when viewed from Github.
## Networks

Testnets can be setup manually on one or more machines, or automatically on one
or more machine, using a variety of methods described in the [deploy testnets
section](./deploy-testnets). For more information (and to join) about the
Cosmos Network testnets, see [here](/getting-started/full-node.md).

## Application Development

The first step to building application on Tendermint is to [install
ABCI-CLI](./getting-started) and play with the example applications.
17 changes: 0 additions & 17 deletions docs/_static/custom_collapsible_code.css

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_static/custom_collapsible_code.js

This file was deleted.

20 changes: 0 additions & 20 deletions docs/_templates/layout.html

This file was deleted.

4 changes: 2 additions & 2 deletions docs/abci-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,6 @@ connects to the app using three separate connections, each with its own
pattern of messages.

For more information, see the [application developers
guide](./app-development.html). For examples of running an ABCI app with
Tendermint, see the [getting started guide](./getting-started.html).
guide](./app-development.md). For examples of running an ABCI app with
Tendermint, see the [getting started guide](./getting-started.md).
Next is the ABCI specification.
2 changes: 1 addition & 1 deletion docs/deploy-testnets.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Here are the steps to setting up a testnet manually:

After a few seconds, all the nodes should connect to each other and
start making blocks! For more information, see the Tendermint Networks
section of [the guide to using Tendermint](using-tendermint.html).
section of [the guide to using Tendermint](./using-tendermint.md).

But wait! Steps 3 and 4 are quite manual. Instead, use [this
script](https://github.com/tendermint/tendermint/blob/develop/docs/examples/init_testnet.sh),
Expand Down
8 changes: 4 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +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.html#ABCI-Overview) that Tendermint Core handles all
ABCI](./introduction.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.
Expand Down Expand Up @@ -58,7 +58,7 @@ Tendermint before, use:
If you have used Tendermint, you may want to reset the data for a new
blockchain by running `tendermint unsafe_reset_all`. Then you can run
`tendermint node` to start Tendermint, and connect to the app. For more
details, see [the guide on using Tendermint](./using-tendermint.html).
details, see [the guide on using Tendermint](./using-tendermint.md).

You should see Tendermint making blocks! We can get the status of our
Tendermint node as follows:
Expand Down Expand Up @@ -224,7 +224,7 @@ But if we send a `1`, it works again:
}

For more details on the `broadcast_tx` API, see [the guide on using
Tendermint](./using-tendermint.html).
Tendermint](./using-tendermint.md).

## CounterJS - Example in Another Language

Expand All @@ -243,7 +243,7 @@ devs, we keep all our code under the `$GOPATH`, so run:

Kill the previous `counter` and `tendermint` processes. Now run the app:

node example/app.js
node example/counter.js

In another window, reset and start `tendermint`:

Expand Down
10 changes: 5 additions & 5 deletions docs/how-to-read-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Next follows a standard block creation cycle, where we enter a new
round, propose a block, receive more than 2/3 of prevotes, then
precommits and finally have a chance to commit a block. For details,
please refer to [Consensus
Overview](introduction.html#consensus-overview) or [Byzantine Consensus
Algorithm](specification.html).
Overview](./introduction.md#consensus-overview) or [Byzantine Consensus
Algorithm](./spec/consensus).

I[10-04|13:54:30.393] enterNewRound(91/0). Current: 91/0/RoundStepNewHeight module=consensus
I[10-04|13:54:30.393] enterPropose(91/0). Current: 91/0/RoundStepNewRound module=consensus
Expand Down Expand Up @@ -100,7 +100,7 @@ Algorithm](specification.html).
Here is the list of modules you may encounter in Tendermint's log and a
little overview what they do.

- `abci-client` As mentioned in [Application Development Guide](app-development.md#abci-design), Tendermint acts as an ABCI
- `abci-client` As mentioned in [Application Development Guide](./app-development.md), Tendermint acts as an ABCI
client with respect to the application and maintains 3 connections:
mempool, consensus and query. The code used by Tendermint Core can
be found [here](https://github.com/tendermint/tendermint/tree/develop/abci/client).
Expand All @@ -115,13 +115,13 @@ little overview what they do.
found
[here](https://github.com/tendermint/tendermint/blob/master/types/events.go).
You can subscribe to them by calling `subscribe` RPC method. Refer
to [RPC docs](specification/rpc.html) for additional information.
to [RPC docs](./specification/rpc.md) for additional information.
- `mempool` Mempool module handles all incoming transactions, whenever
they are coming from peers or the application.
- `p2p` Provides an abstraction around peer-to-peer communication. For
more details, please check out the
[README](https://github.com/tendermint/tendermint/blob/master/p2p/README.md).
- `rpc` [Tendermint's RPC](specification/rpc.html).
- `rpc` [Tendermint's RPC](./specification/rpc.md).
- `rpc-server` RPC server. For implementation details, please read the
[README](https://github.com/tendermint/tendermint/blob/master/rpc/lib/README.md).
- `state` Represents the latest state and execution submodule, which
Expand Down
66 changes: 4 additions & 62 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,68 +6,10 @@
Welcome to Tendermint!
======================

This location for our documentation has been deprecated, please see:

.. image:: assets/tmint-logo-blue.png
:height: 200px
:width: 200px
:align: center
- https://tendermint.com/docs

Introduction
------------
The last version built by Read The Docs will still be available at:

.. toctree::
:maxdepth: 1

introduction.md
install.md
getting-started.md
using-tendermint.md
deploy-testnets.md
ecosystem.md

Tendermint Tools
----------------

.. the tools/ files are pulled in from the tools repo
.. see the bottom of conf.py
.. toctree::
:maxdepth: 1

tools/docker.md
terraform-and-ansible.md
tools/benchmarking.md
tools/monitoring.md

ABCI, Apps, Logging, Etc
------------------------

.. toctree::
:maxdepth: 1

abci-cli.md
abci-spec.md
app-architecture.md
app-development.md
subscribing-to-events-via-websocket.md
indexing-transactions.md
how-to-read-logs.md
running-in-production.md
metrics.md

Research & Specification
------------------------

.. toctree::
:maxdepth: 1

determinism.md
transactional-semantics.md

.. specification.md ## keep this file for legacy purpose. needs to be fixed though

* For a deeper dive, see `this thesis <https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769>`__.
* There is also the `original whitepaper <https://tendermint.com/static/docs/tendermint.pdf>`__, though it is now quite outdated.
* Readers might also be interested in the `Cosmos Whitepaper <https://cosmos.network/whitepaper>`__ which describes Tendermint, ABCI, and how to build a scalable, heterogeneous, cryptocurrency network.
* For example applications and related software built by the Tendermint team and other, see the `software ecosystem <https://tendermint.com/ecosystem>`__.

Join the `community <https://cosmos.network/community>`__ to ask questions and discuss projects.
- https://tendermint.readthedocs.io/projects/tools/en/v0.21.0/
21 changes: 0 additions & 21 deletions docs/specification.rst

This file was deleted.

6 changes: 3 additions & 3 deletions docs/using-tendermint.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ new blockchain will not make any blocks.
## Configuration

Tendermint uses a `config.toml` for configuration. For details, see [the
config specification](./specification/configuration.html).
config specification](./specification/configuration.md).

Notable options include the socket address of the application
(`proxy_app`), the listening address of the Tendermint peer
Expand Down Expand Up @@ -260,7 +260,7 @@ but must be positive, thus the range is: 0 through 9223372036854775807.
Because of how the current proposer selection algorithm works, we do not
recommend having voting powers greater than 10\^12 (ie. 1 trillion) (see
[Proposals section of Byzantine Consensus
Algorithm](./specification/byzantine-consensus-algorithm.html#proposals)
Algorithm](./specification/byzantine-consensus-algorithm.md#proposals)
for details).

If we want to add more nodes to the network, we have two choices: we can
Expand Down Expand Up @@ -398,7 +398,7 @@ failing, you need at least four validator nodes (e.g., 2/3).

Updating validators in a live network is supported but must be
explicitly programmed by the application developer. See the [application
developers guide](./app-development.html) for more details.
developers guide](./app-development.md) for more details.

### Local Network

Expand Down