docs: migrate docs site from Docusaurus to Astro + Starlight#165
Open
andrewfulton9 wants to merge 9 commits into
Open
docs: migrate docs site from Docusaurus to Astro + Starlight#165andrewfulton9 wants to merge 9 commits into
andrewfulton9 wants to merge 9 commits into
Conversation
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.
Summary
DocsGitHub Action (build, unit test, internal link check, deploy), with PR preview URLs and automatic preview cleanup on close, replacing the old GitHub Pages workflow.docs/README.mdand.gitignorefor the new toolchain (Node >=22, npm).Ported from the pattern established in nebari-dev/nebi-pack#40, adapted to this repo (no top-level Makefile exists here, so Makefile/root-README changes were dropped in favor of
docs/README.md). Also fixes a bug present in that reference: Starlight'scustomCssloads each file as an independent stylesheet, so the nebari design tokens'@themeblock never shared a build with an actual@import "tailwindcss"— components rendered unstyled. Consolidated into onedocs/src/styles/tailwind.cssentry point.Test plan
npm ci && npm test— 10/10 passing (remark-base-links plugin)npm run typecheck— 0 errorsnpm run build— succeeds,docs/dist/index.htmlproducedbash scripts/check-links.sh—LINKS_OKat bothBASE=/andBASE=/chat-pack/npm run preview— visually verified in a headless browser: nebari magenta theme, Geist font, sidebar, and filled GitHub button all render correctlyCLOUDFLARE_API_TOKEN/CLOUDFLARE_ACCOUNT_IDsecrets and achat-packCloudflare Pages project exist for the newdocs.yml/docs-preview-cleanup.ymlworkflows to deploy successfully