Files

T

Cyrus GohandMarko 89cb9b0f8c docs: uml hotfix (#9124 )

* comment out ungenerated uml .svg in the md files

* generate svgs to docs/uml
* create docs/uml/svg
* move .punl to docs/uml/puml
* update uml path in md files

* docs: update relative path of uml svg in `x` md files

* docs: remove plantuml script from pre.sh

Co-authored-by: Marko <marbar3778@yahoo.com>

2021-04-16 07:59:21 +00:00

.vuepress

docs: update dropdown 0.41 → 0.42 (#8884 )

2021-03-15 19:21:08 +00:00

architecture

ADR-28 derive address functions (#9088 )

2021-04-15 21:32:45 +00:00

basics

docs: update bech32 account docs (#9006 )

2021-03-29 11:22:30 +00:00

building-modules

docs: uml hotfix (#9124 )

2021-04-16 07:59:21 +00:00

docs: added deprecation notes (#9021 )

2021-03-30 09:19:31 +00:00

core

docs: uml hotfix (#9124 )

2021-04-16 07:59:21 +00:00

ibc

Update overview.md (#9044 )

2021-04-06 15:33:39 +00:00

intro

ascii scheme didn't fit view area (#8892 )

2021-03-17 08:46:00 +00:00

docs: added deprecation notes (#9021 )

2021-03-30 09:19:31 +00:00

migrations

Keyring migrate command doc (#8979 )

2021-04-12 10:18:07 +00:00

docs: added deprecation notes (#9021 )

2021-03-30 09:19:31 +00:00

run-node

Prefer sending tx_bytes to Simulate gRPC endpoint (#8926 )

2021-03-25 10:52:54 +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

DOCS_README.md

docs: Remove legacy Msg/queriers in "Basics" section (#7782 )

2020-11-27 12:57:14 +00:00

package-lock.json

bump vuepress-theme-cosmos (#9099 )

2021-04-13 12:18:47 +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

docs: Add grpc & rest endpoints overview (#8064 )

2020-12-14 10:51:32 +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.
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.
IBC: Documentation for the IBC protocol integration and concepts.
Running a Node, API, CLI: Documentation on how to run a node, and how to interact with it using the CLI and the API.
Migrations: Migration guides for updating to Stargate.

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.