Developer Reference Starlight section
Status: Open — Phase 1, confirmation needed (URL structure, sidebar config)
Problem
Section titled “Problem”Internal developer docs (behavioral specs, ADRs, architecture notes, code tour) are not browsable on the live site. The committed design material is split between roadmap pages and code-level comments, so there is no single browsable developer-reference section in Starlight.
All internal docs browsable at jackin.tailrocks.com/internal/. One unified site for both user documentation and developer reference.
What gets created
Section titled “What gets created”docs/src/content/docs/internal/ index.mdx ← "Developer Reference" landing page architecture.mdx ← high-level module architecture code-tour.mdx ← stub: key call chains (load, console launch, hardline) specs/ ← behavioral + feature specs (runtime-launch, op-picker, ...) decisions/ ← ADRs (ADR-001 through ADR-003, ...)astro.config.ts sidebar addition
Section titled “astro.config.ts sidebar addition”{ label: 'Developer Reference', collapsed: true, items: [ { label: 'Architecture', slug: 'internal/architecture' }, { label: 'Code Tour', slug: 'internal/code-tour' }, { autogenerate: { directory: 'internal/decisions' } }, { autogenerate: { directory: 'internal/specs' } }, ]}- Create the directory structure with stub MDX files (frontmatter + one paragraph).
- Add the sidebar group to
docs/astro.config.ts. - Verify
bun run buildpasses. - Verify
bun run check:links:freshstill passes.
What needs confirmation
Section titled “What needs confirmation”- The URL prefix (
/internal/) — confirm this is the right prefix. collapsed: truefor the sidebar group — confirm this is the right UX default.
Caveats
Section titled “Caveats”Draft MDX pages with broken links will fail the docs-link-check CI gate. Use only working links (or no links) in placeholder pages.