cosmos-sdk/docs
Marie Gauthier eff82d0839
Update Encoding Doc for 0.40 (#7430)
* Remove deprecated docs and add first guidelines to protobuf migration

* Add conventions

* Reorder and add more FAQ doc

* Update guidelines for pb msg definitions

* Use commit hash in github links

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-10-07 12:39:35 +00:00
..
.vuepress docs: Docs theme bump, Algolia DocSearch (#7164) 2020-08-25 20:10:20 +00:00
architecture Updating the ADR template (#7449) 2020-10-05 21:34:41 +00:00
basics docs: fix typo in tx-lifecycle (#7363) 2020-09-22 16:20:00 +01:00
building-modules Removing an incomplete sentence. (#7313) 2020-09-16 08:57:38 +00:00
cn rename RegisterCodec to RegisterLegacyAminoCodec (#7243) 2020-09-07 14:47:12 +00:00
core Update Encoding Doc for 0.40 (#7430) 2020-10-07 12:39:35 +00:00
ibc ibc: core restructure (#7434) 2020-10-02 06:03:02 -03:00
interfaces context: remove verifier & trust node (#6805) 2020-07-23 06:44:18 +00:00
intro typo fix (#6223) 2020-05-14 22:14:08 -04:00
kr context: remove verifier & trust node (#6805) 2020-07-23 06:44:18 +00:00
ru Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
spec Update SPEC-SPEC & documentation for x/{bank,evidence} (#7404) 2020-09-28 13:51:14 -03:00
using-the-sdk Merge PR #5604: docs: minor doc formatting & touchup of the scaffold section 2020-02-04 13:16:56 -05:00
DOCS_README.md Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
README.md docs: update .vuepress/config.js (#6493) 2020-07-01 19:01:15 +02:00
cosmos-sdk-image.jpg Merge PR #4643: Update cosmos sdk image, remove unused images 2019-06-30 16:29:05 -04:00
package-lock.json Bump vuepress-theme-cosmos from 1.0.172 to 1.0.173 in /docs (#7369) 2020-09-23 11:26:16 +00:00
package.json Bump vuepress-theme-cosmos from 1.0.172 to 1.0.173 in /docs (#7369) 2020-09-23 11:26:16 +00:00
post.sh Final updates for new docs website (#5388) 2019-12-11 18:35:27 +01:00
pre.sh Final updates for new docs website (#5388) 2019-12-11 18:35:27 +01:00
versions Add versioned docs to build-docs task (#7413) 2020-09-30 16:12:57 +00:00

README.md

Cosmos SDK Documentation

Get Started

  • SDK Intro: High-level overview of the Cosmos SDK.
  • Quick Start Guide: Scaffold a standard Cosmos SDK app and run a node.
  • SDK Application Tutorial: A tutorial that showcases how to build an SDK-based blockchain from scratch and explains the basic principles of the SDK in the process.

Reference

  • Basics: Documentation on the basic concepts of the Cosmos SDK, like the standard anatomy of an application, the transaction lifecycle and accounts management.
  • Core: Documentation on the core concepts of the Cosmos SDK, like baseapp, the store or the server.
  • Building Modules: Important concepts for module developers like messages, keepers, handlers and queriers.
  • Interfaces: Documentation on building interfaces for Cosmos SDK applications.

Other Resources

Cosmos Hub

The Cosmos Hub (gaia) docs have moved here.

Languages

The Cosmos-SDK is currently written in Golang, though the framework could be implemented similarly in other languages. Contact us for information about funding an implementation in another language.

Contribute

See this file for details of the build process and considerations when making changes.