Skip to content

feat(docs): Move away from MkDocs to Astro Starlight#774

Merged
iambriccardo merged 2 commits into
mainfrom
fix-docs
May 27, 2026
Merged

feat(docs): Move away from MkDocs to Astro Starlight#774
iambriccardo merged 2 commits into
mainfrom
fix-docs

Conversation

@iambriccardo

@iambriccardo iambriccardo commented May 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replaces the MkDocs/Material docs site with an Astro Starlight docs app hosted from dist via GitHub Pages.
  • Moves documentation content into src/content/docs, removes the old MkDocs config and Python docs requirements, and keeps the docs content aligned with current ETL destination/store/event semantics.
  • Adds Supabase-inspired docs styling, improved tables, links, code block language labels, responsive Mermaid rendering, search, sitemap, and generated llms.txt outputs.
  • Updates the docs workflow to build with Node/npm and deploy with the GitHub Pages artifact/deploy actions instead of mkdocs gh-deploy.

MkDocs removal check

  • Removed mkdocs.yaml.
  • Removed docs/requirements_docs.txt.
  • Removed the old MkDocs custom stylesheet under docs/stylesheets/extra.css.
  • Verified no tracked references remain for mkdocs, mkdocs-material, gh-deploy, or the old docs requirements file.
  • Removed ignored local leftovers from the old MkDocs build/venv (site/, venv/) from the checkout.

@iambriccardo iambriccardo marked this pull request as ready for review May 27, 2026 15:01
@iambriccardo iambriccardo requested a review from a team as a code owner May 27, 2026 15:01
@iambriccardo iambriccardo merged commit 4ddcd77 into main May 27, 2026
16 checks passed
@iambriccardo iambriccardo deleted the fix-docs branch May 27, 2026 15:29
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 73.108% (+0.05%) from 73.057% — fix-docs into main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants