This repository contains the code and content for the published along side the Cosmos SDK documentation.
If the tutorial instructs you to download a specific version, that means that the code and the docs for each tutorial are tested, supported, and based on a specific version of the software. Be sure to download and use the right version.
Thank you for helping us to create and maintain this awesome developer portal.
We welcome contributions to the tutorials. Our technical content follows the Google developer documentation style guide:
- Google developer documentation style guide
- Highlights
- Word list
- Style and tone
- Writing for a global audience
- Cross-references
- Present tense
The Google guidelines include more material than is listed here, and are used as a guide that enables easy decision making about proposed content changes.
Other useful resources:
When you submit your PR, please use the default Pull Request template.
The published content currently lives in a few separate folders:
tutorialscontains specific tutorials on different topics
Please note that images must be linked using an absolute path!
Meet the people behind the Cosmos SDK and contributors.
There are two ways to see what your changes will look like in production before the updated pages are published:
- When a PR is ready for review, you can see a preview deployment.
- While a PR is in DRAFT mode, you can preview a local build.
After the PR is created CI will kick off and run. All of ci must pass in order to merge the PR. Once the PR is merged, the changes will be deployed to the production site.
npm run serveto start the local server.
A successful client compile looks like: > VuePress dev server listening at http://localhost:8080/ ✔ Client Compiled successfully in 280.71ms success [12:06:28] Build 03d41f finished in 283 ms! ( http://localhost:8080/ )
You can now view the tutorial build on a local web browser at http://localhost:8080/.