Merge PR cosmos#4426: Anatomy of an SDK App Doc

tuckermint · Jun 12, 2019 · b096357 · b096357
1 parent 58ce605
commit b096357
Show file tree

Hide file tree

Showing 17 changed files with 318 additions and 3 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -29,6 +29,8 @@ module.exports = {
         collapsable: true,
         children: [
           "/intro/",
+          "/intro/why-app-specific",
+          "/intro/sdk-app-architecture",
           "/intro/sdk-design",
           "/intro/ocap"
         ]

diff --git a/docs/concepts/app-anatomy.md b/docs/concepts/app-anatomy.md
diff --git a/docs/concepts/baseapp.md b/docs/concepts/baseapp.md
@@ -32,6 +32,10 @@ The BaseApp is responsible for managing the context passed into handlers -
 it makes the block header available and provides the right stores for `CheckTx`
 and `DeliverTx`. BaseApp is completely agnostic to serialization formats.
 
+## Routing
+
+TODO
+
 ## Transaction Life Cycle
 
 During the execution of a transaction, it may pass through both `CheckTx` and

diff --git a/docs/concepts/encoding.md b/docs/concepts/encoding.md
@@ -0,0 +1,3 @@
+# Encoding
+
+TODO
diff --git a/docs/concepts/fees-signature.md b/docs/concepts/fees-signature.md
@@ -0,0 +1,7 @@
+# Fees and Signatures
+
+## Signatures
+
+## Fees
+
+## Gas
diff --git a/docs/concepts/genesis.md b/docs/concepts/genesis.md
@@ -0,0 +1,3 @@
+# Genesis File
+
+TODO
diff --git a/docs/concepts/handler.md b/docs/concepts/handler.md
@@ -0,0 +1 @@
+# Handlers
diff --git a/docs/concepts/interfaces.md b/docs/concepts/interfaces.md
@@ -0,0 +1,3 @@
+# Interfaces
+
+TODO
diff --git a/docs/concepts/invariants.md b/docs/concepts/invariants.md
@@ -0,0 +1,5 @@
+# Invariants
+
+## What is an invariant
+
+## Invariant Registry
diff --git a/docs/concepts/keeper.md b/docs/concepts/keeper.md
diff --git a/docs/concepts/module-interfaces.md b/docs/concepts/module-interfaces.md
@@ -0,0 +1,5 @@
+# Module Interfaces
+
+## CLI
+
+## REST
diff --git a/docs/concepts/modules.md b/docs/concepts/modules.md
@@ -0,0 +1,8 @@
+# SDK Modules
+
+Todo: Intro concept docs on modules
+
+## Application Module Interface
+
+## Module Manager
+
diff --git a/docs/concepts/node.md b/docs/concepts/node.md
@@ -0,0 +1,13 @@
+# Node Client (Daemon)
+
+## Pre-Requisite Reading
+
+## `main` function
+
+TODO
+
+## `start` command
+
+TODO
+
+## Light-Client Daemon (LCD)
diff --git a/docs/concepts/querier.md b/docs/concepts/querier.md
@@ -0,0 +1,3 @@
+# Queriers
+
+TODO
diff --git a/docs/concepts/tx-lifecycle.md b/docs/concepts/tx-lifecycle.md
diff --git a/docs/intro/README.md b/docs/intro/README.md
@@ -2,9 +2,9 @@
 
 ## What is the SDK?
 
-The [Cosmos-SDK](https://github.com/cosmos/cosmos-sdk) is a framework for building multi-asset public Proof-of-Stake (PoS) blockchains, like the Cosmos Hub, as well as permissioned Proof-Of-Authority (PoA) blockchains. Blockchains built with the Cosmos SDK are generally referred to as **application-specific blockchains**. 
+The [Cosmos-SDK](https://github.com/cosmos/cosmos-sdk) is an open-source framework for building multi-asset public Proof-of-Stake (PoS) blockchains, like the Cosmos Hub, as well as permissioned Proof-Of-Authority (PoA) blockchains. Blockchains built with the Cosmos SDK are generally referred to as **application-specific blockchains**. 
 
-The goal of the Cosmos SDK is to allow developers to easily create custom blockchains from scratch that can natively interoperate with other blockchains. We envision the SDK as the Ruby-on-Rails-like framework to build secure blockchain applications on top of [Tendermint](https://github.com/tendermint/tendermint). SDK-based blockchains are built out of composable modules, most of which are open source and readily available for any developers to use. Anyone can create a module for the Cosmos-SDK, and integrating already-built modules is as simple as importing them into your blockchain application. What's more, the Cosmos SDK is a capabilities-based system, which allows developer to better reason about the security of interactions between modules. For a deeper look at capabilities, jump to [this section](./ocap.md).
+The goal of the Cosmos SDK is to allow developers to easily create custom blockchains from scratch that can natively interoperate with other blockchains. We envision the SDK as the npm-like framework to build secure blockchain applications on top of [Tendermint](https://github.com/tendermint/tendermint). SDK-based blockchains are built out of composable modules, most of which are open source and readily available for any developers to use. Anyone can create a module for the Cosmos-SDK, and integrating already-built modules is as simple as importing them into your blockchain application. What's more, the Cosmos SDK is a capabilities-based system, which allows developers to better reason about the security of interactions between modules. For a deeper look at capabilities, jump to [this section](./ocap.md).
 
 ## What are Application-Specific Blockchains?
 

diff --git a/docs/intro/why-app-specific.md b/docs/intro/why-app-specific.md
@@ -75,5 +75,5 @@ The fundamental issue here is that the governance of the application and the gov
 
 Clearly, application-specific blockchains are awesome. The Cosmos SDK makes it easier than ever to build them. What are you waiting for?
 
+- Learn more about the [high-level architecture](./sdk-app-architecture) of an SDK application.
 - Learn how to build an application-specific blockchain from scratch with the [SDK tutorial](https://cosmos.network/docs/tutorial)
-- Learn more about the [high-level architecture](./sdk-app-architecture) of an SDK application.