Skip to content

Add CI workflow to auto-build and deploy MkDocs documentation to GitHub Pages #461

Description

@sidhantpande

Summary

Following the MkDocs setup in #456, we need a GitHub Actions workflow to
automatically build and deploy the documentation to GitHub Pages whenever
changes are merged into main.

What this adds

A .github/workflows/docs.yml workflow that:

  • Triggers on every push to main and on pull requests
  • Sets up Python 3.10 and uv
  • Installs the docs dependency group (mkdocs, mkdocs-material,
    mkdocstrings)
  • Builds the docs with mkdocs build --strict (fails on warnings)
  • Deploys to GitHub Pages via mkdocs gh-deploy on merges to main

Why This Matters

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions