Astro docs migration#24
Open
andrewfulton9 wants to merge 16 commits into
Open
Conversation
Replace React/Tailwind/shadcn stack with @nebari/starlight theme plugin. Removes: @astrojs/react, @base-ui-components/react, @fontsource packages, @tailwindcss/vite, tailwindcss, class-variance-authority, lucide-react, tailwind-merge, and React types. Adds: @nebari/starlight, @astrojs/markdown-remark. Updates: astro (^7.0.2 -> ^7.0.6). Keeps: @astrojs/starlight, rehype-mermaid, sharp. Leaves devDependencies and engines unchanged.
Remove hand-rolled styling/components and consolidate to shared Nebari theme plugin:
- Import nebari() plugin from @nebari/starlight
- Replace logo/customCss/components with nebari({ logoHref: '...' }) plugin config
- Remove unused dependencies: react(), tailwindcss, fileURLToPath/path, __dirname
- Remove vite plugins/alias block (no longer needed)
- Keep sidebar, markdown config, base, and site settings
Verified: astro build succeeds with @nebari/starlight properly integrated.
No longer needed now that the React/Tailwind component stack and the `@/*` alias are gone with the @nebari/starlight plugin adoption.
Delete shadcn/tailwind config, logos, theme components, and utilities that are now provided by @nebari/starlight plugin: - components.json (shadcn config) - src/assets/*.svg (logo files) - src/components/RepoButton.tsx and SocialIcons.astro - src/components/ui/* (button, spinner) - src/lib/utils.ts (tailwind utilities) - src/styles/* (nebari-tokens, starlight-theme, tailwind.css) Remove empty directories: src/components, src/styles, src/assets, src/lib. Keep docs/public/favicon.svg as browsers request it directly.
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
1 participant
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.
Reference Issues or PRs
Closes #22
What does this implement/fix?
Summary
Migrates the docs site from Docusaurus to Astro + Starlight, matching the pattern established in nebari-dev/nebi-pack#40 and nebari-dev/llm-serving-pack#120, per the checklist in #22.
components.jsonregistry, and sharedButton/Spinner/RepoButton/SocialIconscomponents.remark-base-linksplugin (with unit tests) so internal links work correctly both at/and under a deployed subpath.docs/README.mdwith the new npm commands (dev/build/preview/test) and testing/link-checking instructions.scripts/check-links.sh, an internal link checker run in CI and available locally.docs.ymlworkflow that builds, unit-tests, link-checks, and deploys to Cloudflare Pages (with PR preview URLs and a cleanup workflow for closed PRs)..gitignorefor Astro build artifacts (docs/dist/,docs/.astro/) in place of the old Docusaurus entries.Out of scope (intentionally): this repo has no top-level
Makefile(onlydev/Makefile, for the unrelated Tilt-based operator dev loop), so nomake docs-*targets were added and the top-levelREADME.mdwas left untouched — doc-update instructions live entirely indocs/README.md.Testing
npm install,npm test(10/10 passing),npm run build, andbash scripts/check-links.shall pass locally. CI runs the same checks and additionally deploys to Cloudflare Pages (requires theCLOUDFLARE_API_TOKEN/CLOUDFLARE_ACCOUNT_IDrepo secrets to be configured).Documentation
docs/README.mddocuments the new install/dev/build/preview/test/link-check workflow and CI.Access-centered content checklist
Text styling
H1or#in markdown).Non-text content
Any other comments?
None of the doc page prose changed — only the site generator, styling, and CI/deploy mechanism.