Skip to content

docs: mkdocs GitHub Pages deploy - #3

Merged
stefan-jansen merged 8 commits into
mainfrom
docs/mkdocs-setup
Apr 2, 2026
Merged

docs: mkdocs GitHub Pages deploy#3
stefan-jansen merged 8 commits into
mainfrom
docs/mkdocs-setup

Conversation

@stefan-jansen

Copy link
Copy Markdown
Contributor

Summary

  • Add GitHub Pages deploy workflow (docs.yml) — builds on push to main, deploys via actions/deploy-pages
  • Update nav in mkdocs.yml to include all 8 user guide pages (was missing 5)
  • Replace Sphinx deps with mkdocs-material + mkdocstrings in pyproject.toml
  • Pin mkdocs<2 (Material not yet compatible with MkDocs 2.0)
  • Fix broken links in ml-readiness.md
  • Add site/ to .gitignore

Test plan

  • mkdocs build --strict passes locally
  • CI passes (lint, typecheck, tests)
  • After merge, docs workflow deploys to GitHub Pages

Note: GitHub Pages needs to be enabled in repo settings (Settings > Pages > Source: GitHub Actions) before the deploy will work.

Copilot AI review requested due to automatic review settings March 3, 2026 17:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an automated MkDocs-based documentation deployment to GitHub Pages and updates documentation configuration/links to match the new docs site location.

Changes:

  • Replace Sphinx tooling with MkDocs Material + mkdocstrings in project extras.
  • Update MkDocs config/nav and fix a couple of internal docs links.
  • Add a GitHub Actions workflow to build and deploy docs to GitHub Pages.

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.

File Description
pyproject.toml Swaps docs dependencies to MkDocs stack and updates the published documentation URL.
mkdocs.yml Adjusts site/repo URLs and expands nav to include all user guide pages.
docs/user-guide/ml-readiness.md Fixes internal links to point at the correct pages under MkDocs.
.github/workflows/docs.yml Adds CI workflow to build MkDocs site and deploy via GitHub Pages actions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pyproject.toml
Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/docs.yml
@stefan-jansen
stefan-jansen merged commit ae0c805 into main Apr 2, 2026
4 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants