From ca5e837e54eaf0874ef1ab22d4f3ae4625c007aa Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Wed, 7 Feb 2018 16:23:21 +0000 Subject: [PATCH] docs: prettify & organize --- docs/ibc.rst | 8 ++++---- docs/index.rst | 10 +++++++--- docs/{ => sdk}/glossary.rst | 0 docs/sdk/overview.rst | 4 +++- 4 files changed, 14 insertions(+), 8 deletions(-) rename docs/{ => sdk}/glossary.rst (100%) diff --git a/docs/ibc.rst b/docs/ibc.rst index f2392aaaa6..30b9a16faf 100644 --- a/docs/ibc.rst +++ b/docs/ibc.rst @@ -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) @@ -18,8 +18,8 @@ serialized IBC transaction type. 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 blockchain to function as a light-client of another. Since we are using diff --git a/docs/index.rst b/docs/index.rst index b54e16e46d..fb58f318c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,11 +14,14 @@ Welcome to the Cosmos SDK! SDK --- +.. One maxdepth for now + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 sdk/overview.rst sdk/install.rst + sdk/glossary.rst .. Basecoin .. -------- @@ -52,8 +55,9 @@ Staking Module Extras ------ +.. One maxdepth for now + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 ibc.rst - glossary.rst diff --git a/docs/glossary.rst b/docs/sdk/glossary.rst similarity index 100% rename from docs/glossary.rst rename to docs/sdk/glossary.rst diff --git a/docs/sdk/overview.rst b/docs/sdk/overview.rst index 5f513bf8af..9072f97dc4 100644 --- a/docs/sdk/overview.rst +++ b/docs/sdk/overview.rst @@ -118,6 +118,7 @@ Capabilities systems ~~~~~~~~~~~~~~~~~~~~ TODO: + * Need for module isolation * Capability is implied permission * Link to thesis @@ -126,7 +127,7 @@ Tx & Msg ~~~~~~~~ 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 ^^^^^^^^ @@ -319,6 +320,7 @@ Mounting an IAVLStore ^^^^^^^^^^^^^^^^^^^^^ TODO: + * IAVLStore: Fast balanced dynamic Merkle store. * supports iteration.