Updating documentation (this website)

This project uses the Diátaxis technical documentation framework. The website is generated using mdBook 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:

just docs

Then visit localhost:8000

Deployment

It’s running on GitHub Pages under the pages branch (so even if my homelab goes down everyone can still read the documentation).

To publish:

just publish