cosmos-sdk/docs
Denis Fadeev ced06f22a4
Docs website update (#5958)
* add transactions into core

* checkout master-docs files

* deleted some

* remove modules readme

* cli.md comments

* comments

* module-interfaces comments

* Merge PR #4857: Add Context concept doc

* working

* working

* finish messages and queries

* handler

* querier

* last comments!

* punctuation

* querier2

* consolidate intro

* querier

* workiiiing

* refactor for new module interface

* karoly review

* working on baseapp doc

* baseapp work

* reorg

* almost there

* finish first draft

* remove old files

* finish intro

* workinnn

* initial commit after rebase

* query-lifecycle and started modules-interfaces

* query-lifecycle first draft done

* module interfaces first draft

* rest and intro skeletons

* rest and intro done

* small edits and links

* comments

* revisions

* cli.md comments

* comments

* minor edits

* better flow for query lifecycle

* checkout master-docs files

* deleted some

* remove modules readme

* cli.md comments

* comments

* module-interfaces comments

* keeper

* genesis

* finish

* Apply suggestions from code review

Co-Authored-By: Hans Schoenburg <hschoenburg@users.noreply.github.com>

* hans review

* Update docs/core/baseapp.md

Co-Authored-By: Hans Schoenburg <hschoenburg@users.noreply.github.com>

* working

* last comment

* workin

* Apply suggestions from code review

* encoding and node

* almost finish store

* finish docs

* fixes

* fede comments + permalinks

* hans review

* add more permalinks

* update docs theme version (#5239)

* R4R: Docs Cleanup (#5246)

* start

* work

* work

* work

* remove table of content

* links intro

* fix links

* remove junk

* cleanup

* cleanup

* work

* finish cleanup

* addback readmes

* remove nft

* fix links

* remove dup

* remove dup

* remove dup

* remove dup

* remove dup

* fix links

* add subscribe events

* refine rest

* index page

* sidebar

* theme version

* theme version

* testing netlify

* theme version

* tooltip example

* version

* testing code embedding

* reverting back

* theme version

* version

* version

* version

* readme and version

* cleanup

* redo app anatomy

* modules readme, theme version

* theme version

* fix modules list

* theme version

* new snippets

* modules readme

* update docs readme

* modify synopsis

* version

* fix yaml

* version

* version

* version

* version

* version

* version

* version

* version

* version

* version

* add hide banner

* version

* version

* version

* small fixes

* modules readme, version

* remove hotkeys dep, version

* version

* version

* version

* version

* version

* version

* version

* slight notice

* fix links and hide

* permalinks

* small clean

* version

* resolve conflicts, add google analytics

* fix merge remants

* version

* changelog 1/2

* Changelog: docs UI

* version

* remove merge conflicts

* Code: Update link for Contributing to the docs to docs_readme

* HTML/CSS: Update layout of homepage footer to match new layout in Figma

* version

* final modifs

* modules, version

* modules readme

* link to module list from homepage

* version

* building modules link

* version

* version

* fonts

* version

* version

* fix link

* fix package.json

* links in explore sdk section

* core concepts

* version

* change delimeters for frontmatter

* frontmatter in comments

* version

* temp add tiny-cookie

* fixed link issues

* fixed styling issues, copy

* hide frontmatter

* hide frontmatter

* layout fixes, padded ascii diagram

* fira sans font for code

* scrollbar color

* move synopsis from frontmatter

* move synopsis from frontmatter

* code styling in synopsis fix

* tutorial link

* active headers

* 404 fix

* homepage links fix

* fix link in footer

* misc fixes

* version

* prerequisite links on mobile

* version

* version

* Fix footer links

* version

* Fix permalink popup

* Update version

* package-lock.json

* Update Questions section in the footer

* Config for Algolia Docsearch

* Update version

* Update to the latest version of the theme

* Use docs-staging as a branch for staging website

* Update version

* Add google analytics

* Remove {hide} from Pre-Requisite Readings

* Replace Riot with Discord

Co-Authored-By: billy rennekamp <billy.rennekamp@gmail.com>

* Fix yaml syntax error in docs

* Fix formatting in keyring.md

* Change versions file

* Change versions file

* versions

* version

* Escaping HTML entities

* Newline

* Fix

* Update version

* Version

* Remove test string from code block

* Revert formatting

Co-authored-by: Gloria Zhao <gzhao408@berkeley.edu>
Co-authored-by: gamarin <gautier@tendermint.com>
Co-authored-by: Jack Zampolin <jack.zampolin@gmail.com>
Co-authored-by: Hans Schoenburg <hschoenburg@users.noreply.github.com>
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
2020-04-17 09:01:11 +00:00
..
.vuepress Update docs website (#5827) 2020-03-24 16:20:30 +00:00
architecture Merge PR #6007: update 03 adr 2020-04-16 14:19:06 -04:00
basics Update docs website (#5827) 2020-03-24 16:20:30 +00:00
building-modules Update docs website (#5827) 2020-03-24 16:20:30 +00:00
cn docs(cn): match new docs in intro and basics 2020-04-01 20:52:04 +08:00
core Merge PR #5952: Refactor Evidence Age Util + Governable Consensus Params 2020-04-16 11:10:39 -04:00
interfaces Improve keyring docs (#5822) 2020-03-24 16:30:35 +00:00
intro Update docs website (#5827) 2020-03-24 16:20:30 +00:00
kr Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
ru Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
spec x/ibc: IBC alpha (#5277) 2020-04-08 20:57:52 -04:00
using-the-sdk Merge PR #5604: docs: minor doc formatting & touchup of the scaffold section 2020-02-04 13:16:56 -05: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 Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
package-lock.json Docs website update (#5958) 2020-04-17 09:01:11 +00:00
package.json Docs website update (#5958) 2020-04-17 09:01:11 +00: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
README.md Add quick start guide (#5517) 2020-01-17 18:11:22 +01:00
Screen Shot 2019-10-17 at 15.07.22.png Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00
versions Merge PR #4984: Switch docs version to master 2019-09-03 12:43:33 -04:00

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

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.