Skip to content

docs: stand up MkDocs Material Pages site - #88

Merged
joshua-temple merged 1 commit into
mainfrom
docs/pages-site
Jun 10, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/pages-site

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Stands up a GitHub Pages documentation site for cascade using MkDocs Material.

  • Adds mkdocs.yml with the Material theme, full nav across all seven existing docs files (Getting Started, Manifest Reference, Callback Contract, Workflows, CLI Reference, Architecture, Versioning & Schema), and MkDocs extensions for code highlighting, Mermaid fences, and tabbed content
  • Adds docs/requirements.txt pinning mkdocs-material==9.6.14
  • Adds .github/workflows/pages.yml: builds on every push to main or PR touching docs/**/mkdocs.yml; deploys to Pages on push to main only; all actions SHA-pinned; least-privilege permissions (pages: write + id-token: write scoped to the deploy job only)
  • Fixes three broken ../CHANGELOG.md / ../SECURITY.md relative links in versioning.md that pointed outside the docs tree -- replaced with absolute GitHub URLs; mkdocs build --strict now passes clean

Enabling Pages in repo Settings (source: GitHub Actions) is a separate manual step after merge.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit dd98d87 into main Jun 10, 2026
6 checks passed
@joshua-temple
joshua-temple deleted the docs/pages-site branch June 10, 2026 10:46
@joshua-temple joshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant