Imported from XoRHub/website (
AGENTS.md). Install upstream withnpx skills add XoRHub/website. Copyright stays with the author.
AGENTS.md — working on the WaaS docs site as a coding agent
Docusaurus site (docs-only mode) documenting WaaS
(XoRHub/waas) and waas-images
(XoRHub/waas-images) for end
users. Published to GitHub Pages at https://xorhub.github.io/website/.
Ground rules
- Facts come from the source repos. This site paraphrases
waas/docs/*.md,waas/helm/waas/README.mdand the waas-images README/CONTRIBUTING/HARDENING — never invent behavior; when in doubt, read the source repo (often available as sibling checkouts../waasand../waas-images). Never modify those repos from here. - Audience is the end user (platform admin or workspace user) — not contributors to the waas codebase. Internal CI, code structure and contributor workflows stay in the source repos.
- Generated files are never hand-edited:
docs/reference/crds/*.mdx(gitignored, regenerated bynpm run gen:crdbefore every start/build) andversioned_docs/**/reference/crds/*.mdx(frozen snapshots cut bydocusaurus docs:version). versioned_docs/is frozen history — editdocs/(the Next version) unless fixing a factual error in a released snapshot.- Missing screenshots are gray placeholders tracked in
IMAGES_TODO.md+ aTODO(image)MDX comment at each use site. Adding one: update all three (image file, comment, TODO list).
Toolchain
Everything through mise (.mise.toml is the single source, CI installs
from it via jdx/mise-action):
mise install
npm ci
npm start # dev server (runs gen:crd first)
npm run build # what CI runs — must pass, fails on broken links
npm run typecheck
Key moving parts
| What | Where |
|---|---|
| CRD schema sync (from waas, ref pinned) | scripts/sync-crd-schemas.mjs, crd-schemas/WAAS_REF |
| CRD page generator | scripts/generate-crd-docs.mjs (npm run gen:crd) |
| Docs version cut (on waas release) | .github/workflows/version-cut.yml; procedure in CONTRIBUTING.md |
| Pages deploy | .github/workflows/deploy.yml (build PRs, deploy main) |
| Sidebar | sidebars.ts — new pages must be added there |
Commits
Conventional Commits, atomic: docs: content, feat: site/generator
features, ci:, chore:, fix:. Same doctrine as the source repos.
Definition of done
npm run build green (it regenerates the CRD pages and checks every
link across all versions), npm run typecheck green, new pages wired
into sidebars.ts, placeholders tracked in IMAGES_TODO.md.
