Docs Build Workflow
The documentation for Tendermint Core is hosted at:
built from the files in this (
/docs) directory for
How It Works
There is a CircleCI job listening for changes in the
/docs directory, on both
master branch. Any updates to files in this directory
on those branches will automatically trigger a website deployment. Under the hood,
the private website repository has a
make build-docs target consumed by a CircleCI job in that repo.
The README.md is also the landing page for the documentation on the website. During the Jenkins build, the current commit is added to the bottom of the README.
The config.js generates the sidebar and Table of Contents on the website docs. Note the use of relative links and the omission of file extensions. Additional features are available to improve the look of the sidebar.
NOTE: Strongly consider the existing links - both within this directory and to the website docs - when moving or deleting files.
Links to directories MUST end in a
Relative links should be used nearly everywhere, having discovered and weighed the following:
Where is the other file, relative to the current one?
- works both on GitHub and for the VuePress build
- confusing / annoying to have things like:
- requires more updates when files are re-shuffled
Where is the other file, given the root of the repo?
- works on GitHub, doesn't work for the VuePress build
- this is much nicer:
- if you move that file around, the links inside it are preserved (but not to it, of course)
The full GitHub URL to a file or directory. Used occasionally when it makes sense to send users to the GitHub.
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.
Install the theme and all dependencies.
npm run serve
post hooks and start a hot-reloading web-server. See output of this command for the URL (it is often https://localhost:8080).
To build documentation as a static website run
npm run build. You will find the website in
Because the build processes are identical (as is the information contained herein), this file should be kept in sync as much as possible with its counterpart in the Cosmos SDK repo.