docs: stand up MkDocs Material Pages site - #88
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stands up a GitHub Pages documentation site for cascade using MkDocs Material.
mkdocs.ymlwith 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 contentdocs/requirements.txtpinningmkdocs-material==9.6.14.github/workflows/pages.yml: builds on every push tomainor PR touchingdocs/**/mkdocs.yml; deploys to Pages on push tomainonly; all actions SHA-pinned; least-privilege permissions (pages: write+id-token: writescoped to the deploy job only)../CHANGELOG.md/../SECURITY.mdrelative links inversioning.mdthat pointed outside the docs tree -- replaced with absolute GitHub URLs;mkdocs build --strictnow passes cleanEnabling Pages in repo Settings (source: GitHub Actions) is a separate manual step after merge.