History

Albert Chon 1330b62c5f fix: broken link to IBC specs (#9715 )		2021-07-18 13:35:45 -04:00
..
.vuepress	docs: clean up translations and readme (#9539 )	2021-07-05 10:07:26 +00:00
architecture	Merge branch 'master' into hulatown/adr-043-nft	2021-07-03 21:13:06 +08:00
basics	fix interfaces links (#9448 )	2021-06-08 12:03:42 +00:00
building-modules	docs: Add docs for setting store loader (#9526 )	2021-06-17 15:04:33 +00:00
core	feat: Add group module proto definitions and basic types (#9631 )	2021-07-09 07:36:16 +00:00
ibc	fix: broken link to IBC specs (#9715 )	2021-07-18 13:35:45 -04:00
intro	chore: add markdownlint to lint commands (#9353 )	2021-05-27 15:31:04 +00:00
ko	docs: clean up translations and readme (#9539 )	2021-07-05 10:07:26 +00:00
migrations	refactor(client): add client/Context.Codec and deprecate JSONCodec (#9498 )	2021-06-11 11:49:39 +00:00
ru	docs: clean up translations and readme (#9539 )	2021-07-05 10:07:26 +00:00
run-node	docs: simd testnet commands (#9411 )	2021-07-15 20:52:54 +00:00
spec	chore: add markdownlint to lint commands (#9353 )	2021-05-27 15:31:04 +00:00
uml	docs: uml hotfix (#9124 )	2021-04-16 07:59:21 +00:00
using-the-sdk	docs: Fix simulation docs link (#9452 )	2021-06-04 07:24:57 +00:00
zh	docs: clean up translations and readme (#9539 )	2021-07-05 10:07:26 +00:00
DOCS_README.md	docs: clean up translations and readme (#9539 )	2021-07-05 10:07:26 +00:00
DOC_WRITING_GUIDELINES.md	docs: use RFC 2119 keywords (#9532 )	2021-06-22 00:04:55 +00:00
README.md	docs: clean up translations and readme (#9539 )	2021-07-05 10:07:26 +00: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	build(deps): bump prismjs from 1.23.0 to 1.24.0 in /docs (#9600 )	2021-07-01 17:09:35 +00:00
package.json	bump vuepress-theme-cosmos (#9099 )	2021-04-13 12:18:47 +00:00
post.sh	Final updates for new docs website (#5388 )	2019-12-11 18:35:27 +01:00
pre.sh	docs: uml hotfix (#9124 )	2021-04-16 07:59:21 +00:00
protodoc-markdown.tmpl	Add script to generate proto-docs (#8238 )	2020-12-31 16:10:13 +00:00
versions	docs: add v0.43 version option (#9506 )	2021-06-28 14:34:48 -07:00

README.md

Cosmos SDK Documentation

Get Started

SDK Intro: High-level overview of the Cosmos SDK.
Starport: A developer-friendly interface to the Cosmos SDK to scaffold a standard Cosmos SDK blockchain app.
SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain 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 message, keeper, and querier.
IBC: Documentation for the IBC protocol integration and concepts.
Running a Node, API, CLI: Documentation on how to run a node and interact with the node using the CLI and the API.
Migrations: Migration guides for updating to newer versions of the SDK.

Other Resources

Module Directory: Cosmos SDK module implementations and their respective documentation.
Specifications: Specifications of modules and other parts of the Cosmos SDK.
SDK API Reference: Godocs of the Cosmos SDK.
REST and RPC Endpoints: List of endpoints to interact with a gaia full-node.

Cosmos Hub

The Cosmos Hub (gaia) docs have moved to github.com/cosmos/gaia.

Languages

The Cosmos SDK is 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 the DOCS_README.md for details of the build process and considerations when making changes.