T-G0D2-gs-documentation-site
Status: closed/superseded · Impact: medium · Complexity: large
Build a full documentation site for graph-scheduler, mirroring the intersect docs site (Astro/Starlight + TypeDoc API pages + guide + use-cases + playground).
Greenfield — nothing in the graph-scheduler package exists yet; it is stood up by T-PDDK-gs-scaffold-package-and-tooling and its layers land task by task. This task contributes the documentation site.
Proposed
Section titled “Proposed”A docs-site/ (Astro Starlight) like packages/ts/intersect/docs-site/, with: a
getting-started guide, concept pages (frontier, status/trigger-rules, filters,
sorters, goal-direction, pull, tracker), TypeDoc-generated API reference,
use-case pages (orchestrator parallel dispatch, goal-directed work), and at least
one interactive playground. Built output under sites/graph-scheduler-api/ like
sites/intersect-api/.
Approach
Section titled “Approach”- Copy the intersect docs-site scaffold and re-theme for graph-scheduler.
- Author the guide, concept, and use-case pages from the design docs.
- Wire TypeDoc to generate the API reference from the package.
- Add a playground; confirm the site builds.
Files to touch
Section titled “Files to touch”| Location | Kind | Change |
|---|---|---|
packages/ts/graph-scheduler/docs-site/ | new | Astro Starlight site (guide, concepts, playground) |
sites/graph-scheduler-api/ | new | Built site output |
Acceptance criteria
Section titled “Acceptance criteria”- An Astro/Starlight docs site exists with getting-started, concept pages, and use-cases.
- A TypeDoc-generated API reference covers the public surface.
- At least one interactive playground; the site builds cleanly.
Out of scope
Section titled “Out of scope”- Hosting/deploy configuration beyond the build.
Dependencies
Section titled “Dependencies”- T-N2EJ-gs-package-exports-and-readiness — the docs site documents the finalized public surface and exports.
Depends on
Section titled “Depends on”T-N2EJ-gs-package-exports-and-readiness