Migrate documentation platform from MkDocs to Astro Starlight#22
Open
rajneesh407 wants to merge 3 commits into
Open
Migrate documentation platform from MkDocs to Astro Starlight#22rajneesh407 wants to merge 3 commits into
rajneesh407 wants to merge 3 commits into
Conversation
rajneesh407
force-pushed
the
migrate-docs-to-astro-starlight
branch
3 times, most recently
from
2b59b26 to
9cfdf69
Compare
Replace the MkDocs Material site with an Astro Starlight (Astro 6 / Starlight 0.39) static site for faster, more modern, and more extensible docs experience (built-in search, code copy, dark/light, MDX components). What changed: - Content moved from docs/ to src/content/docs/ (Markdown + one MDX page). Admonitions -> Starlight asides, internal .md links -> relative clean URLs, Material icon shortcodes stripped, helper-panel custom elements preserved, images co-located (auto-optimized to webp at build). - pipelines page rebuilt as MDX using CardGrid/Card and Tabs/TabItem. - Sidebar/nav translated from docs/.nav.yml into astro.config.mjs; Corridor navy theme, logo/favicon, social links, Google Analytics, edit links, last-updated, and image zoom configured. - Dual-base build via DOCS_BASE: default '/' for the offline Flask package (corridor_docs/site, served by `corridor-docs run`) and '/ggx-docs/' for GitHub Pages. - deploy.yml rewritten for Node + Astro + GitHub Pages; build.sh, requirements.txt, README, and .gitignore updated. Dropped: the full-site PDF user-manual export (no Starlight equivalent) and Mermaid (configured but unused in content). The Python/Flask offline-serving distribution is retained. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
rajneesh407
force-pushed
the
migrate-docs-to-astro-starlight
branch
2 times, most recently
from
e1f8c3d to
aebd704
Compare
Make the pipelines page a world-class reference and bring the docs theme in line with ggx.corridorplatforms.com. - Pipelines page reworked to use meaningful Starlight components instead of cards everywhere: Steps for procedures (registration, test flows), Tabs for pipeline types and code variants, Badges, and LinkCards/LinkButton for "what's next". Reference content (variables, risk dimensions, capabilities) moved to scannable tables. Cleaner H2/H3 hierarchy and a page description for better TOC and search indexing. - Added three hand-authored, brand-styled SVG diagrams (IVR example flow, pipeline anatomy, testing levels) and removed the unused excalidraw placeholders. - Brand theme: self-hosted DM Sans / DM Mono via @fontsource (offline friendly), refined navy accents, and figure/card/aside polish. - Component links use import.meta.env.BASE_URL so they resolve correctly under both the '/' (Flask package) and '/ggx-docs/' (GitHub Pages) bases. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
rajneesh407
force-pushed
the
migrate-docs-to-astro-starlight
branch
from
aebd704 to
101bc5c
Compare
Rewrite the home page (index.md to index.mdx) with an accurate Corridor GenGuardX overview, the industry problem, and how GGX solves it, sourced from the GGX site and press release. Add on-brand SVG diagrams for the AI trust lifecycle, trust cycle, and production monitoring funnel. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.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
2 participants
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.
Summary
Migrates the GGX documentation site from MkDocs Material to Astro Starlight (Astro 6 / Starlight 0.39) for a faster, more modern, and more extensible docs experience — built-in search (Pagefind), code copy, dark/light themes, and MDX components.
What changed
docs/tosrc/content/docs/(Markdown + one MDX page). Automated conversion: MkDocs admonitions (!!! note) -> Starlight asides (:::note), internal.mdlinks -> relative clean URLs, Material icon shortcodes stripped,<helper-panel>custom elements preserved, and images co-located (auto-optimized to webp at build).pipelinespage was rebuilt as.mdxusing<CardGrid>/<Card>and<Tabs>/<TabItem>.docs/.nav.ymlintoastro.config.mjs; Corridor navy theme, logo/favicon, social links, Google Analytics, edit links, last-updated, and image zoom configured.DOCS_BASE: default/for the offline Flask package (corridor_docs/site, served bycorridor-docs run) and/ggx-docs/for GitHub Pages.deploy.ymlrewritten for Node + Astro + GitHub Pages;build.sh,requirements.txt,README, and.gitignoreupdated.Dropped / retained
Reviewer notes
gh-pagesbranch).global-functionswas added to the sidebar — it exists as a page but was missing from the old.nav.yml. Remove if that was intentional.🤖 Generated with Claude Code