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
Amaury 29c7a469fe
refactor: Bring back deprecated proto fields to `v1beta1` (#9534) 
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: #9446 

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
 		2021-06-23 13:03:33 +00:00
..
.vuepress docs: update dropdown 0.41 → 0.42 (#8884) 2021-03-15 19:21:08 +00:00
architecture docs: use RFC 2119 keywords (#9532) 2021-06-22 00:04:55 +00:00
basics fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
building-modules docs: Add docs for setting store loader (#9526) 2021-06-17 15:04:33 +00:00
cn fix interfaces links (#9448) 2021-06-08 12:03:42 +00:00
core refactor: Bring back deprecated proto fields to `v1beta1` (#9534) 2021-06-23 13:03:33 +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 refactor(client): add client/Context.Codec and deprecate JSONCodec (#9498) 2021-06-11 11:49:39 +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 docs: use RFC 2119 keywords (#9532) 2021-06-22 00:04:55 +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 postcss from 7.0.35 to 7.0.36 in /docs (#9525) 2021-06-17 05:52:08 +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.