If you want to read the documentation, you should go here. This repository is for the documentation source files.
This is a CI (continuous integration) enabled project. This means that your contributions will be automatically tested to ensure they build correctly before being allowed into the repo. It also means that the live website will automatically update as soon as your changes are accepted.
- Ensure you can run
hugoandnpmfrom the console of your choice. On windows, this will probably bepowershell. On mac, this will probably beterminal. On Linux, this is any terminal emulator, including a bare vtty. If you can't run these commands, you might need to add them to your path. See the relevant OS documentation for more info. - Clone this repository and change directories into it.
- Initialize the git submodule by running
git submodule update --init --recursive - Run
npm install. - Run
hugo serverto start the dev server. You should be able to view a local copy of this website at http://localhost:1313/Documentation/
- Run the spellchecker (
npx cspell --config .ci/cspell.json 'content/**/*.md') before submitting your changes. The build will fail if you have any spelling errors or words it doesn't know about and you'll have to fix them. - Always view your changes on the local server before submitting. If you changes cause a render failure, you will also have to redo them.
- All documentation lives in the folder content/docs
- All CI configuration files and scripts live in the .ci folder. The only
file you should edit here, unless you know exactly what you are doing, is
the
dict.txtfile. Please add yoru custom dictionary entries in alphabetical order, preserving the current ordering. You should probably study these files so you learn how CI works - The Github workflow config file is located in
.github/workflows. This configure Github's built-in CI runner.