0ad9b4e4fe
minor edits while I was in here updating the Starport description, thanks <!-- 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: #XXXX <!-- 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... - [ ] 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 - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] 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) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] 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... - [x] 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 - [x] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable) |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| architecture | ||
| basics | ||
| building-modules | ||
| core | ||
| ibc | ||
| intro | ||
| ko | ||
| migrations | ||
| ru | ||
| run-node | ||
| spec | ||
| uml | ||
| using-the-sdk | ||
| zh | ||
| DOCS_README.md | ||
| DOC_WRITING_GUIDELINES.md | ||
| README.md | ||
| cosmos-sdk-image.jpg | ||
| package-lock.json | ||
| package.json | ||
| post.sh | ||
| pre.sh | ||
| protodoc-markdown.tmpl | ||
| versions | ||
README.md
Cosmos SDK Documentation
Get Started
- Cosmos SDK Intro: High-level overview of the Cosmos SDK.
- Starport: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain.
- SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic Cosmos SDK principles in the process.
Reference Docs
- Basics: Basic concepts of the Cosmos SDK, including the standard anatomy of an application, the transaction lifecycle, and accounts management.
- Core: Core concepts of the Cosmos SDK, including
baseapp, thestore, or theserver. - Building Modules: Important concepts for module developers like
message,keeper, andquerier. - IBC: IBC protocol integration and concepts.
- Running a Node, API, CLI: How to run a node and interact with the node using the CLI and the API.
- Migrations: Migration guides for updating to newer versions of Cosmos SDK.
Other Resources
- Module Directory: Cosmos SDK 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 and RPC Endpoints: List of endpoints to interact with a
gaiafull-node. - Rosetta API: Rosetta API integration.
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.