Skip to content

docs: migrate docs UI to Astro Starlight - #128

Merged
joshua-temple merged 3 commits into
mainfrom
docs/astro-starlight-ui
Jun 12, 2026
Merged

joshua-temple merged 3 commits into
mainfrom
docs/astro-starlight-ui

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

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

  • Replace the MkDocs Material site with an Astro Starlight stack (astro, @astrojs/starlight, astro-mermaid), mirroring the suite docs setup.
  • Apply the cascade brand: cyan-teal (#36D0C4) accent tokens, dark-default theme with a light toggle, PNG favicon and upper-left logo, hero and avatar art.
  • Port every docs page into the Starlight content collection with frontmatter, preserving the previous nav order in the sidebar. Convert internal links to Starlight routes.
  • Realign the system-overview and primary/satellite ASCII diagrams, and render the manifest state machine as a Mermaid statechart.
  • Retire mkdocs.yml, the docs requirements file, and the old Pages workflow; replace them with an Astro build + Pages deploy workflow.
  • Reorder the README badges to Go Reference, Go Report Card, Go Version, Docs, and add the avatar at the top and the hero in the overview.

Verification

  • cd docs && npm install && npm run build builds all 9 pages clean (mermaid block transformed, hero optimized, search index built).
  • actionlint .github/workflows/docs-deploy.yaml passes.
  • No doc content lost: all eight pages ported with line counts intact.

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>
@joshua-temple
joshua-temple merged commit 8f44be2 into main Jun 12, 2026
8 checks passed
@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