HowTo update documentation¶

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

There are 4 main parts:

• Getting started (tutorials): learning-oriented
• Concepts (explanation): understanding-oriented
• How-to guides: goal-oriented
• Reference: information-oriented

Local development¶

To edit and view locally, run:

make docs

Then visit localhost:8000

Deployment¶

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