History

Sunny Aggarwal a77eb251f1 Merge branch 'master' into sunny/change-pubkey-adr		2020-11-27 12:07:03 -05:00
..
.vuepress	docs: Docs theme bump, Algolia DocSearch (#7164 )	2020-08-25 20:10:20 +00:00
architecture	Update adr-034-account-rekeying.md	2020-11-24 13:06:58 -05:00
basics	docs: Remove legacy Msg/queriers in "Basics" section (#7782 )	2020-11-27 12:57:14 +00:00
building-modules	Update "Core Concepts" docs (#7948 )	2020-11-24 15:03:20 +00:00
cn	docs: fix broken url in cn/basics/app-anatomy.md (master) (#7831 )	2020-11-06 11:21:53 +00:00
core	Update "Core Concepts" docs (#7948 )	2020-11-24 15:03:20 +00:00
ibc	counterParty -> counterparty (#7946 )	2020-11-16 15:06:55 +00:00
interfaces	docs: Add new section "Running a Node" (#7701 )	2020-11-04 14:02:22 +00:00
intro	[docs]: update building modules section to reflect ADR31 (#7702 )	2020-11-17 20:41:43 +00:00
kr	context: remove verifier & trust node (#6805 )	2020-07-23 06:44:18 +00:00
migrations	Fix legacy querying tx ("unregistered type" bug) (#7992 )	2020-11-25 12:02:31 +00:00
ru	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
run-node	Update "Core Concepts" docs (#7948 )	2020-11-24 15:03:20 +00:00
spec	docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} (#7407 )	2020-10-16 12:42:48 +00:00
using-the-sdk	Update cosmovisor.md (#7837 )	2020-11-06 11:05:41 +00:00
DOCS_README.md	docs: Remove legacy Msg/queriers in "Basics" section (#7782 )	2020-11-27 12:57:14 +00: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	build(deps): bump vuepress-theme-cosmos from 1.0.173 to 1.0.175 in /docs (#7806 )	2020-11-04 10:40:25 +01:00
package.json	build(deps): bump vuepress-theme-cosmos from 1.0.173 to 1.0.175 in /docs (#7806 )	2020-11-04 10:40:25 +01: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	docs: add newline to versions file (#7938 )	2020-11-17 19:25:32 +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

Module Directory: 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 API spec: List of endpoints to interact with a gaia full-node through REST.

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.