diff --git a/docs/Makefile b/docs/Makefile index f39025bdd..f8d1790de 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = python -msphinx -SPHINXPROJ = Ethermint +SPHINXPROJ = Tendermint SOURCEDIR = . BUILDDIR = _build diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..180acdcb9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,14 @@ +Here lies our documentation. After making edits, run: + +``` +pip install -r requirements.txt +make html +``` + +to build the docs locally then open the file `_build/html/index.html` in your browser. + +**WARNING:** This documentation is intended to be viewed at: + +https://tendermint.readthedocs.io + +and may contain broken internal links when viewed from Github. diff --git a/docs/images/tmint-logo-blue.png b/docs/images/tmint-logo-blue.png new file mode 100644 index 000000000..cc4c8fb82 Binary files /dev/null and b/docs/images/tmint-logo-blue.png differ diff --git a/docs/index.rst b/docs/index.rst index a219532a8..55f6097f3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,13 +3,20 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Tendermint's documentation! -====================================== +Welcome to Tendermint! +====================== -Tendermint 101: + +.. image:: images/tmint-logo-blue.png + :height: 500px + :width: 500px + :align: center + +Tendermint 101 +-------------- .. maxdepth set to 2 for sexiness -.. but use 4 to upgrade documentation +.. but use 4 to upgrade overall documentation .. toctree:: :maxdepth: 2 @@ -19,7 +26,8 @@ Tendermint 101: deploy-testnets.rst using-tendermint.rst -Tendermint 102: +Tendermint 102 +-------------- .. toctree:: :maxdepth: 2 @@ -28,50 +36,17 @@ Tendermint 102: app-architecture.rst app-development.rst -Tendermint 201: +Tendermint 201 +-------------- .. toctree:: :maxdepth: 2 - specification - -Documentation (to refactor) ---------------------------- - -If you're new here, start with the [Tendermint Intro](/intro). - -To start building an ABCI application and integrating with Tendermint, -see the [App Development](/docs/guides/app-development) -and [App Architecture](/docs/guides/app-architecture) guides. - -To learn more about running the Tendermint software, see the [Using Tendermint Guide](/docs/guides/using-tendermint). - -To learn more about Tendermint's various pieces, check out the [Documentation](/docs). -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. -You 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 details on how the software has changed, and what changes are in store, see the [Changelog](https://github.com/tendermint/tendermint/blob/master/CHANGELOG.md) and the [Roadmap](https://github.com/tendermint/tendermint/blob/master/roadmap.md). - -If you're interested in contributing, see our [Contributor Guidelines](https://github.com/tendermint/tendermint/blob/master/CONTRIBUTING.md) - -The Tendermint [Software Ecosystem](/ecosystem) contains many example applications and related software built by the Tendermint team and others. -Check it out for some motivation and inspiration! - -See our [Community](/community) page for more ways to collaborate. - -You can also [get in touch with the team](/contact). - -Most importantly, enjoy! - -Next Steps ----------- - - - + specification.rst -Indices and tables -================== +* For a deeper dive, see `this thesis `__. +* There is also the `original whitepaper `__, though it is now quite outdated. +* Readers might also be interested in the `Cosmos Whitepaper `__. -:ref:`Keyword Index `, :ref:`Search Page ` +Join the `Cosmos and Tendermint Rocket Chat `__ to ask questions and discuss projects.