LaconicNetwork/cosmos-sdk
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
61bd6cbd12
cosmos-sdk/docs
History
Robert Zaremba 1de12aae67
docs: adding documentation writing guidelines (#9366) 
* docs: adding documentation writing guidelines

* update

* Apply suggestions from code review

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>

Co-authored-by: likhita-809 <78951027+likhita-809@users.noreply.github.com>
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
2021-05-25 15:10:17 +00:00
..
.vuepress docs: update dropdown 0.41 → 0.42 (#8884) 2021-03-15 19:21:08 +00:00
architecture rosetta: upgrade to newest version (#9314) 2021-05-15 00:18:59 +02:00
basics doc: Updates related to ServiceMsg, sdk.Msg and Msg service (#9294) 2021-05-12 15:47:54 +00:00
building-modules docs: update module interfaces (#9322) 2021-05-19 20:00:57 +00:00
cn docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
core update spec and fix code snippets (#9334) 2021-05-19 20:22:06 +00:00
ibc Adding the ts-relayer to the implementations list (#9380) 2021-05-21 11:35:31 +00:00
intro Update why-app-specific.md (#9349) 2021-05-19 10:37:31 +00:00
kr docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
migrations doc: Updates related to ServiceMsg, sdk.Msg and Msg service (#9294) 2021-05-12 15:47:54 +00:00
ru docs: added deprecation notes (#9021) 2021-03-30 09:19:31 +00:00
run-node cosmovisor: set larger buffer size for cosmovisor to scan log (fix #8651) (#8653) 2021-05-20 19:29:56 +00:00
spec docs: update bech32 account docs (#9006) 2021-03-29 11:22:30 +00:00
uml docs: uml hotfix (#9124) 2021-04-16 07:59:21 +00:00
using-the-sdk docs: Remove deprecated "Interfaces" section (#8294) 2021-01-18 00:11: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
DOC_WRITING_GUIDELINES.md docs: adding documentation writing guidelines (#9366) 2021-05-25 15:10:17 +00:00
DOCS_README.md docs: Remove legacy Msg/queriers in "Basics" section (#7782) 2020-11-27 12:57:14 +00:00
package-lock.json build(deps): bump browserslist from 4.16.4 to 4.16.6 in /docs (#9389) 2021-05-25 14:47:32 +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
README.md Update README.md (#9181) 2021-04-22 21:02:53 +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.