856cc5b096
## Description Recently when discussing NFT standard we stumbled upon the proper use of keywards such as SHOULD, MAY etc ... Let's add them to our guidelines. --- ### 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 `docs:` prefix in the PR title - [x] 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 - [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md) - [x] 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 `docs:` prefix in the PR title - [ ] confirmed all author checklist items have been addressed - [x] confirmed that this PR only changes documentation - [x] reviewed content for consistency - [x] reviewed content for thoroughness - [x] reviewed content for spelling and grammar - [ ] tested instructions (if applicable) |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| architecture | ||
| basics | ||
| building-modules | ||
| cn | ||
| core | ||
| ibc | ||
| intro | ||
| kr | ||
| migrations | ||
| ru | ||
| run-node | ||
| spec | ||
| uml | ||
| using-the-sdk | ||
| 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
- 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, thestore, or theserver. - Building Modules: Important concepts for module developers like
message,keeper,handler, andquerier. - 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
- 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 API spec: List of endpoints to interact with a
gaiafull-node through REST.
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.