certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: prettify & organize

This commit is contained in:
Zach Ramsay 2018-02-07 16:23:21 +00:00 committed by Ethan Buchman
parent fd5dfc5944
commit ca5e837e54
4 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/ibc.rst
View File

@ -1,5 +1,5 @@
InterBlockchain Communication with the Cosmos SDK IBC
================================================= ===
TODO: update in light of latest SDK (this document is currently out of date) TODO: update in light of latest SDK (this document is currently out of date)
@ -18,8 +18,8 @@ serialized IBC transaction type.
We'll demonstrate exactly how this works below. We'll demonstrate exactly how this works below.
IBC Inter BlockChain Communication
--- ------------------------------
Let's review the IBC protocol. The purpose of IBC is to enable one Let's review the IBC protocol. The purpose of IBC is to enable one
blockchain to function as a light-client of another. Since we are using blockchain to function as a light-client of another. Since we are using

10
docs/index.rst
View File

@ -14,11 +14,14 @@ Welcome to the Cosmos SDK!
SDK SDK
--- ---
.. One maxdepth for now
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
sdk/overview.rst sdk/overview.rst
sdk/install.rst sdk/install.rst
sdk/glossary.rst
.. Basecoin .. Basecoin
.. -------- .. --------
@ -52,8 +55,9 @@ Staking Module
Extras Extras
------ ------
.. One maxdepth for now
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
ibc.rst ibc.rst
glossary.rst

0
docs/glossary.rst → docs/sdk/glossary.rst
View File

4
docs/sdk/overview.rst
View File

@ -118,6 +118,7 @@ Capabilities systems
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
TODO: TODO:
* Need for module isolation * Need for module isolation
* Capability is implied permission * Capability is implied permission
* Link to thesis * Link to thesis
@ -126,7 +127,7 @@ Tx & Msg
~~~~~~~~ ~~~~~~~~
The SDK distinguishes between transactions (Tx) and messages The SDK distinguishes between transactions (Tx) and messages
(Msg). A Tx is a Msg wrapped with authentication and fee data. (Msg). A Tx is a Msg wrapped with authentication and fee data.
Messages Messages
^^^^^^^^ ^^^^^^^^
@ -319,6 +320,7 @@ Mounting an IAVLStore
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
TODO: TODO:
* IAVLStore: Fast balanced dynamic Merkle store. * IAVLStore: Fast balanced dynamic Merkle store.
* supports iteration. * supports iteration.