docs: migrate docs UI to Astro Starlight - #128
Merged
Merged
Conversation
Add the Astro Starlight docs stack (astro, @astrojs/starlight, astro-mermaid) alongside the cascade brand theme: cyan-teal accent tokens, PNG favicon and logo, hero and avatar assets, and a GitHub Pages deploy workflow. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
Move every docs page into the Starlight content collection with frontmatter, convert internal links to Starlight routes, add a splash landing page, and realign the system-overview and primary/satellite ASCII diagrams (the manifest state machine now renders as a Mermaid statechart). Retire mkdocs.yml, the docs requirements file, and the old Pages workflow. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
Lead the README with the cascade avatar and reorder the badge block to match the suite convention: Go Reference, Go Report Card, Go Version, Docs. Wire the hero illustration into the overview section. 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.
Problem
The docs site runs on MkDocs Material, which diverges from the rest of the suite. Several ASCII diagrams in the content are misaligned, and the README badge block and brand art are inconsistent with the suite convention.
Fix
Verification
cd docs && npm install && npm run buildbuilds all 9 pages clean (mermaid block transformed, hero optimized, search index built).actionlint .github/workflows/docs-deploy.yamlpasses.