Goal
Automatically publish the MkDocs manual to GitHub Pages on main merges (or tags), using GitHub Actions.
Scope
- Add a deploy workflow:
- Build docs with
mkdocs build --strict
- Publish
site/ to GitHub Pages (gh-pages)
- Configure repository Pages settings:
- Optional: tag-based release deploy
Acceptance Criteria
- Manual is published to GitHub Pages after a merge to
main
- Build uses the same MkDocs deps as local docs build
- Failures in doc build block deployment
Notes
- Use
actions/configure-pages, actions/upload-pages-artifact, actions/deploy-pages.
- Keep this separate from CI (do not slow down tests).