214b11dcba
* feat: add github links in docs * apply proto theme * fix toc |
||
|---|---|---|
| .. | ||
| architecture | ||
| docs | ||
| spec | ||
| src/css | ||
| static | ||
| .gitignore | ||
| DOC_WRITING_GUIDELINES.md | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| modules_category.json | ||
| package-lock.json | ||
| package.json | ||
| post.sh | ||
| pre.sh | ||
| sidebars.js | ||
| tailwind.config.js | ||
| vuepress_versions | ||
README.md
Updating the docs
If you want to open a PR in Cosmos SDK to update the documentation, please follow the guidelines in CONTRIBUTING.md.
Docs Build Workflow
The documentation for Cosmos SDK is hosted at https://docs.cosmos.network and built from the files in the /docs directory.
It is built using Docusaurus 2, a modern static website generator.
How It Works
There is a GitHub Action listening for changes in the /docs directory for the main branch and each supported version branch (e.g. release/v0.46.x). Any updates to files in the /docs directory will automatically trigger a website deployment. Under the hood, the private website repository has a make build-docs target consumed by a Github Action within that repository.
README
The README.md is both the README for the repository and the configuration for the layout of the landing page.
Links
NOTE: Strongly consider the existing links - both within this directory and to the website docs - when moving or deleting files.
Relative links should be used nearly everywhere, due to versionning. Note that in case of page reshufling, you must update all links references.
Full
The full GitHub URL to a file or directory. Used occasionally when it makes sense to send users to the GitHub.
Building Locally
Make sure you are in the docs directory and run the following commands:
rm -rf node_modules
This command will remove old version of the visual theme and required packages. This step is optional.
npm install
Install the theme and all dependencies.
npm start
Run pre and post hooks and start a hot-reloading web-server. See output of this command for the URL (it is often https://localhost:3000).
To build documentation as a static website run npm run build.
Search
We are using Algolia to power full-text search. This uses a public API search-only key in the config.js as well as a cosmos_network.json configuration file that we can update with PRs.