certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs
History
Augustin Chan 98cf72c4ba
style: fix lint errors and update lint timeout (#9464) 
* fix: misc fixes for make to work off freshly cloned repo

* gocritic appendAssign fix

* markdown trailing space and blank line fixes

* change golangci-lint timeout to 5min

* update changelog

* Update .golangci.yml

Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>

* Update CHANGELOG.md

Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>

Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
 		2021-06-08 16:27:39 +00:00
..
.vuepress docs: update dropdown 0.41 → 0.42 (#8884) 2021-03-15 19:21:08 +00:00
architecture chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
basics fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
building-modules fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
cn fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
core style: fix lint errors and update lint timeout (#9464) 2021-06-08 16:27:39 +00:00
ibc chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
intro chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
kr fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
migrations chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
ru chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
run-node chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +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
DOCS_README.md fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
DOC_WRITING_GUIDELINES.md style: fix lint errors and update lint timeout (#9464) 2021-06-08 16:27:39 +00:00
README.md fix interfaces links (#9448) 2021-06-08 12:03:42 +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 ws from 6.2.1 to 6.2.2 in /docs (#9461) 2021-06-07 08:31:20 +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 add newline at end of docs/versions file (#8900) 2021-03-17 08:53:51 +00: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 Application Tutorial: A tutorial that showcases how to build a Cosmos 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 message, keeper, handler, 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 Stargate.

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.