cosmos-sdk/docs
Noam 06c5d2bebc
docs: update mentions of starport to ignite cli (#11612)
2022-04-12 16:26:30 +02:00
..
.vuepress remove top banner (#10530) 2021-11-12 14:19:24 +01:00
architecture refactor: Small clarifications to authz docs and one error description (#11506) 2022-04-03 09:50:51 +00:00
assets docs: adding acceptance tests description (#10534) 2021-12-10 01:34:34 +00:00
basics fixing typos (#11447) 2022-03-24 16:33:48 +01:00
building-modules docs: add module migration order guidance (#11255) 2022-02-23 23:41:48 +01:00
core docs: fixes the documentation build (#11542) 2022-04-05 11:44:11 +02:00
ibc docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
intro docs: Fix the broken links in the documents (#11477) 2022-03-30 07:29:35 +00:00
ko docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
migrations docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
ru style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
run-node docs: add mention of modes from 0.35 (#11167) 2022-02-11 13:32:18 +01:00
spec docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
uml docs: uml hotfix (#9124) 2021-04-16 07:59:21 +00:00
using-the-sdk docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
zh docs: clean up translations and readme (#9539) 2021-07-05 10:07:26 +00:00
404.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
DOCS_README.md docs: Code blocks in SDK docs are broken (#11189) 2022-02-14 23:39:35 +01:00
DOC_WRITING_GUIDELINES.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
README.md docs: update mentions of starport to ignite cli (#11612) 2022-04-12 16:26:30 +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 minimist from 1.2.5 to 1.2.6 in /docs (#11448) 2022-03-24 13:52:40 +01:00
package.json build(deps): Bump vuepress-theme-cosmos from 1.0.182 to 1.0.183 in /docs (#10966) 2022-01-19 11:47:52 +01:00
post.sh docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
pre.sh docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
protodoc-markdown.tmpl Add script to generate proto-docs (#8238) 2020-12-31 16:10:13 +00:00
versions docs: update to v0.44 version tag (#10069) 2021-09-08 08:34:54 -07:00

README.md

Cosmos SDK Documentation

Get Started

  • Cosmos SDK Intro: High-level overview of the Cosmos SDK.
  • Ignite CLI: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain.
  • SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic Cosmos SDK principles in the process.

Reference Docs

  • Basics: Basic concepts of the Cosmos SDK, including the standard anatomy of an application, the transaction lifecycle, and accounts management.
  • Core: Core concepts of the Cosmos SDK, including baseapp, the store, or the server.
  • Building Modules: Important concepts for module developers like message, keeper, and querier.
  • IBC: IBC protocol integration and concepts.
  • Running a Node, API, CLI: 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 Cosmos SDK.

Other Resources

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.