This repository contains the code and content for the published Cosmos SDK Tutorials.
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.
- To set up the portal locally, please follow the Local setup and build guide in the TECHNICAL SETUP document. You might also want to read the further environment tips in that file.
- To provide feedback, file an issue and provide abundant details to help us understand how we can make it better.
- To provide feedback and a fix, you can make a direct contribution. This repo is protected since we provide the code and the docs to help you learn. If you're not a member or maintainer, fork the repo and then submit a Pull Request from your forked repo to master.
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.
This documentation platform is using VuePress with a custom theme, which is referenced in this repo as Submodule.
The main VuePress configuration file is located at .vuepress/config.js.
The layout metadata at the top of the README.md file controls the main landingpage (/). Write permissions are limited to preserve the structure and contents.
The published content currently lives in a few separate folders:
academycontains the Cosmos Academy contenttutorialscontains specific tutorials on different topicshands-on-exercisecontains the hands-on modules
Note: The folder ida-customizations contains files used for the IDA build of the platform.
There is a hidden file (not linked in the main menu) published at /feature-test, which demonstrates the use of all custom components used on this platform. This page is also available on the deployed website at https://tutorials.cosmos.network/feature-test/. You can always refer to this page when you need a reference for a component integration.
Please note that images must be linked using an absolute path!
A special note on svg images: They are currently not processed by the asset pipeline, therefore, svgs must be placed in a static asset folder (.vuepress/public/). Landingpage images are stored in the lp-images sub-folder. To embed such an image, you can embed /lp-images/go-lp.svg, which then points to the file at .vuepress/public/lp-images/go-lp.svg.
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 moves from Draft to Ready for review, the CI status checks generate a Netlify deploy preview. Netlify keeps this preview up to date as you continue to work and commit new changes to the same branch.
To view a deployed preview on a Ready for review PR, click the Details link on the netlify commit status line:
To view a local preview of a branch, follow the steps outlined in the TECHNICAL SETUP guide to clone and install the app. Then, checkout the branch you would like to preview and run:
npm run serve
to 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/.