feat(docs): Docusaurus documentation site + generated API reference + doc tests (Step 7.5) - #178
Merged
Conversation
… doc tests (Step 7.5) Publish the docs as a Docusaurus 3 site that sources the repo docs/ tree in place (single source of truth, no copy step; markdown.format 'detect' so the hand-written .md renders as CommonMark). - website/: Docusaurus scaffold (config, sidebars, theme, tsconfig). - scripts/gen_api_reference.py: renders dist/openapi.json -> docs/reference/ rest-api.md (43 paths). Drift-gated like dist/schemas + the proto stubs. - tests/docs/: asserts every ragctl subcommand and /v1 path in a quickstart is real (registered CLI command / OpenAPI path). No services needed. - .github/workflows/docs.yml: api-ref drift, doc tests, codespell, lychee offline link-check, npm run build. - task docs:api / docs:dev / docs:build. Deferred: Algolia search, versioned docs, the deploy workflow. Also records the backlog PR-history rows for #175-#177. ADR-0047. Verified locally: ruff, ruff format, tests/docs (3), gen_api_reference run, 208-link relative check. (npm site build is a CI step.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
officialCodeWork
force-pushed
the
build/phase-7/step-7.5-documentation-site
branch
from
June 9, 2026 21:12
d771f07 to
6ba32a6
Compare
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.
Step 7.5 — Documentation site
A Docusaurus 3 site (
website/) that serves the repodocs/tree in place —docs/stays the single source of truth, the site renders it (no copy step).What's here
website/— Docusaurus scaffold (config, autogenerated sidebar, theme, tsconfig).markdown.format: 'detect'so the existing hand-written.mdrenders as CommonMark.scripts/gen_api_reference.pyrendersdist/openapi.json→docs/reference/rest-api.md(43 paths). CI regenerates + diffs it likedist/schemasand the proto stubs, so published API docs always match the gateway.tests/docs/asserts everyragctl <cmd>and/v1/...path in a quickstart is a real CLI command / OpenAPI path. Deterministic, no services.docsCI workflow — api-ref drift · doc-tests ·codespell·lychee --offlinelink-check ·npm run build.task docs:api/docs:dev/docs:build, a guide, and ADR-0047.Verification (local)
ruff+ruff format✅ ·tests/docs(3 tests) ✅ · generator runs (43 paths) ✅ · 208-link relative check ✅Housekeeping
Also records the missing PR-history rows for #175–#177 in
TRACKER.md.🤖 Generated with Claude Code