docs: define official pack docs site requirements and gate GA on a compliant site#20
Merged
Merged
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.
Two related changes:
New
docs/pack-docs-requirements.md: defines what a compliant official pack docs site is. Stack (Astro + the shared@nebari/starlighttheme, source in the pack repo,base: /<slug>/), the baseline two-section layout modeled on the LLM Serving Pack site, and the publication mechanics (Cloudflare Pages project named after the repo,docs_site: truein pack-metadata.yaml, listing in the dashboard's tracked-packs.yaml, which routespacks.nebari.dev/<slug>/). Ends with a compliance checklist.Maturity model update: the release readiness checklist's Documentation section gains a GA row requiring a compliant docs site published at
packs.nebari.dev/<slug>/.Reference implementation for the requirements: https://packs.nebari.dev/llm-serving-pack/. The routing mechanics were verified against
generate_routes.pyin software-pack-dashboard.