Skip to content

Updating documentation (this website)

This project uses the Diátaxis technical documentation framework. The website is generated using Material for MkDocs and can be viewed at

There are 4 main parts:

Local development

To edit and view locally, run:

make docs

Then visit localhost:8000


It's running on my other cluster in the khuedoan/horus project (so if the homelab goes down everyone can still read the documentation).