Deployment and GitHub Pages

This project publishes documentation automatically to GitHub Pages using the gh-pages branch.

Workflow

File:

• .github/workflows/docs.yml

Behavior:

• Pull requests to main touching docs files run a strict docs build.
• Pushes to main touching docs files run build and deploy.
• Manual runs are available with workflow_dispatch.

Deployment target

• Branch: gh-pages
• Published folder: site/ generated by mkdocs build --strict

Local preview before push

bash uv sync --extra docs --group dev mkdocs build --strict mkdocs serve