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 homelab2.e-whisper.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

For stability and performance, it's running on Cloudflare Pages.

To deploy, see this documentation: MkDocs · Cloudflare Pages docs.

Steps like below: