This is our shared knowledge Vault. This is a public repository so do not share any confidential information here!
Creating new pages is really easy. Everything is stored inside the docs directory as Markdown files. Content should be organized in directories such that none of the posts are at the top level. If you need a new top-level directory for your content, then just create one. This will appear as an item in the top navigation menu. Remember to add a file called index.md too if needed.
Internal linking is encouraged! Create normal relative Markdown links to other posts as needed.
If you want to add a notification you can use admonitions like this:
!!! note
This is a notification
If you have an idea but don't have the time to write about it right now, you should create a new issue. New issues appear automatically in the topic tracking project, and they are also automatically marked as Done when closed. If you reference an issue in a pull request (e.g. Closes #1 or Resolves #2) then merging the PR will automatically close the related issue.
The website is generated with Material for MkDocs. It is published on GitHub Pages using GitHub Actions with the deployment script. Basic configuration is done with the mkdocs.yml file and theme overrides are located in the theme directory.
You can build the site locally by installing the Python requirements and running the local development server:
python3 -m venv venv
. venv/bin/activate
python3 -m pip install -r requirements.txt
mkdocs serve