Template · docs-portal
Documentation portal
Technical docs your agents can read, update, and keep honest.
Spine's docs-portal template compiles a working contract for a technical docs site — quickstart, guides, reference, changelog, versioning — with drift checks so stale docs fail CI instead of rotting in the open.
Who this template is for
Open-source maintainers. DevRel teams. Anyone whose docs are one release behind and whose agents keep hallucinating the old API.
Get started
~ — spine init --template docs-portal
$ npm install -g project-spine@next $ spine init --template docs-portal $ spine compile --brief ./brief.md --repo . --template docs-portal ✓ wrote spine.json ✓ wrote AGENTS.md, CLAUDE.md, copilot-instructions.md ✓ wrote scaffold-plan, qa-guardrails, sprint-1-backlog
Routes this template plans for
- / — Landing with quickstart CTA and top guides
- /quickstart — 5-minute setup
- /guides — Task-oriented topic index
- /reference — Generated API reference
- /changelog — Release notes, newest first
What spine compile emits
- Sidebar nav contract with active-state + collapsible sections
- Search contract — what's indexed, how stale content is flagged
- Versioning rules for API reference
- Guide style guardrails — heading depth, code samples, callouts
- Drift rules that fail CI when reference pages and code diverge
Good fit if
- Dev tools launching v1 docs
- Teams whose docs keep drifting behind the API
- Projects with multiple versions live at once
Pairs well with
- design-systemTokens, primitives, Storybook, docs — compiled into rules every consumer repo inherits.