2017-11-11 14:40:20 +04:00
|
|
|
.. Tezos documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Sat Nov 11 11:08:48 2017.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2018-02-20 12:58:51 +04:00
|
|
|
|
2018-04-17 13:44:00 +04:00
|
|
|
Welcome to the Tezos Developer Documentation!
|
|
|
|
|
=============================================
|
2018-02-20 12:58:51 +04:00
|
|
|
|
|
|
|
|
Tezos is a distributed consensus platform with meta-consensus
|
|
|
|
|
capability. Tezos not only comes to consensus about the state of its ledger,
|
|
|
|
|
like Bitcoin or Ethereum. It also attempts to come to consensus about how the
|
|
|
|
|
protocol and the nodes should adapt and upgrade.
|
|
|
|
|
|
|
|
|
|
- Developer documentation is available online at http://doc.tzalpha.net
|
2018-05-17 13:36:11 +04:00
|
|
|
- The official Tezos website https://tezos.com/ contains more information about the
|
2018-05-17 12:56:39 +04:00
|
|
|
project.
|
|
|
|
|
- All development now happens on GitLab at https://gitlab.com/tezos/tezos
|
2018-02-20 12:58:51 +04:00
|
|
|
|
|
|
|
|
The Tezos Alpha (test) network has been live and open since February 2017.
|
|
|
|
|
|
|
|
|
|
- More information on joining the Alphanet at :ref:`here <alphanet>`.
|
|
|
|
|
- Several community built block explorers are available:
|
|
|
|
|
|
|
|
|
|
- http://ostez.com
|
|
|
|
|
- http://tzscan.io
|
|
|
|
|
- https://tezos.id
|
|
|
|
|
- https://tezoschain.io
|
|
|
|
|
|
|
|
|
|
- A few community run websites collect useful Tezos links:
|
|
|
|
|
|
|
|
|
|
- http://www.tezos.help
|
|
|
|
|
- https://tezos.rocks
|
|
|
|
|
|
|
|
|
|
- There is a matrix channel *Tezos* that you can join `here <https://riot.im/app/#/room/#tezos:matrix.org>`_.
|
|
|
|
|
- There is a *#tezos* channel on *freenode* that is reserved for technical discussions
|
2018-05-17 13:36:11 +04:00
|
|
|
- There is also a community FAQ at https://github.com/tezoscommunity/faq/wiki/Tezos-Technical-FAQ
|
2018-02-20 12:58:51 +04:00
|
|
|
|
|
|
|
|
The source code of Tezos is currently under exclusive copyright of
|
|
|
|
|
Dynamic Ledger Solutions, and will be open sourced under the MIT
|
|
|
|
|
license when the main network lunches.
|
2017-11-11 14:40:20 +04:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Introduction:
|
|
|
|
|
|
2018-02-20 12:58:51 +04:00
|
|
|
introduction/howto
|
2017-11-11 14:40:20 +04:00
|
|
|
introduction/contributing
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: The Alphanet:
|
|
|
|
|
|
|
|
|
|
introduction/alphanet
|
|
|
|
|
introduction/alphanet_changes
|
|
|
|
|
introduction/zeronet
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: White doc:
|
|
|
|
|
|
|
|
|
|
whitedoc/the_big_picture
|
2018-02-20 21:28:05 +04:00
|
|
|
whitedoc/p2p
|
2017-11-15 19:16:53 +04:00
|
|
|
whitedoc/validation
|
2017-11-11 14:40:20 +04:00
|
|
|
whitedoc/michelson
|
2018-01-27 04:44:07 +04:00
|
|
|
whitedoc/proof_of_stake
|
2017-11-11 14:40:20 +04:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2018-02-06 18:22:07 +04:00
|
|
|
:caption: Developer Tutorials:
|
2017-11-11 14:40:20 +04:00
|
|
|
|
|
|
|
|
tutorials/data_encoding
|
|
|
|
|
tutorials/error_monad
|
|
|
|
|
tutorials/michelson_anti_patterns
|
|
|
|
|
tutorials/entering_alpha
|
|
|
|
|
tutorials/protocol_environment
|
2018-02-06 18:22:07 +04:00
|
|
|
tutorials/profiling
|
2017-11-11 14:40:20 +04:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2018-01-31 15:23:03 +04:00
|
|
|
:caption: APIs:
|
2017-11-11 14:40:20 +04:00
|
|
|
|
|
|
|
|
README
|
|
|
|
|
api/api-inline
|
2018-01-31 15:23:03 +04:00
|
|
|
api/cli-commands
|
2018-03-07 13:44:24 +04:00
|
|
|
api/rpc
|
2018-03-14 19:20:24 +04:00
|
|
|
api/errors
|
2017-11-11 14:40:20 +04:00
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
