How to sideload the Documentation

📘 How to sideload the Documentation

This guide explains how to install dependencies, run the documentation locally, build versioned docs using mike, and sideload the generated site for validation or packaging.

📦 Installing Dependencies

Install everything needed for documentation:

uv sync --group dev

🖥️ Running the Documentation Locally

MkDocs includes a built‑in development server with live reload.

Start it with:

uv run mkdocs serve

This launches the docs at:

http://127.0.0.1:8000

If port 8000 is already in use:

uv run mkdocs serve -a 127.0.0.1:8001