Add base Astro + Nebari Starlight docs site (experimental) - #5
Merged
Conversation
Scaffolds a docs/ site mirroring the other software packs: Astro with the @astrojs/starlight integration, Nebari branding via the @nebari/starlight theme plugin, and BASE/SITE env-var support for portal deployment. The landing page is a placeholder marking the docs as experimental with content coming soon. Closes #4 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Marks docs_site: true and points links.docs at the packs portal URL in pack-metadata.yaml. Adds the standard Docs CI workflow (build, internal link check, Cloudflare Pages deploy with PR preview comments), the preview-cleanup workflow, and the shared check-links.sh script, all mirroring the other software packs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
📄 Docs preview for |
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.
Closes #4
Summary
Scaffolds an experimental
docs/site mirroring the pattern used by the other software packs (nebari-chat-pack,mlflow-pack,harbor-pack, ...):@astrojs/starlightproject underdocs/(astro.config.mjs,src/content/docs/,public/)@nebari/starlighttheme plugin withnebari({ logoHref: 'https://packs.nebari.dev/' })astro.config.mjsrespects theBASEandSITEenv vars for portal deployment, plus theremark-base-linksplugin so root-absolute links work under a base pathREADME.mdnow points todocs/and how to run it locally;docs/README.mdcovers install/dev/build/previewNow that the Cloudflare Pages project exists, this PR also wires up deployment:
pack-metadata.yaml:docs_site: trueandlinks.docs: https://packs.nebari.dev/pi-coding-agent-pack/(validated against the dashboard schema).github/workflows/docs.yml: build, internal link check, Cloudflare Pages deploy, PR preview URL comment (same pinned actions as the other packs).github/workflows/docs-preview-cleanup.yml: deletes preview deployments when a PR closesscripts/check-links.sh: shared internal link checkerVerification
npm install && npm run dev— serves locally; landing page renders with title and experimental bannernpm run build— clean static buildSITE=https://packs.nebari.dev BASE=/pi-coding-agent-pack/ npm run build— asset/link paths correctly prefixed with/pi-coding-agent-pack/BASE=/pi-coding-agent-pack/ SKIP_BUILD=1 bash scripts/check-links.sh—LINKS_OKpack-metadata.yamlvalidates against the dashboard schema (check-jsonschema)Requirements
Deploys need the
CLOUDFLARE_API_TOKENandCLOUDFLARE_ACCOUNT_IDrepository secrets and a Cloudflare Pages project namedpi-coding-agent-pack.Out of scope (per #4)
🤖 Generated with Claude Code