Skip to content

CI-041 - Publish Markdown Documentation With MkDocs Material

Summary

Added a repeatable MkDocs Material publishing path for the tooling documentation. Local operators can build or serve the HTML site from the same configuration that GitHub Actions uses for GitHub Pages deployment.

Completed Work

  • Added the MkDocs configuration, documentation dependency file, and web landing page.
  • Added browser-facing CSS to keep wide Markdown tables readable through horizontal scrolling.
  • Added a GitHub Pages workflow that builds on pull requests and deploys from main.
  • Kept docs/INDEX.md as both the repository navigation index and MkDocs home page, with a static docs/index.html root redirect, so Windows checkouts do not need a case-only index.md twin.

Validation

  • git diff --check
  • python scripts\docs-item-taxonomy-check.py
  • python scripts\docs-structure-check.py
  • python scripts\github-roadmap-check.py
  • python -m pip install -r requirements-docs.txt
  • $env:NO_MKDOCS_2_WARNING='1'; python -m mkdocs build --strict