Layout
Composition principles
Keep the selected API operation and product context visible. Constrain prose width, preserve code line wrapping controls, and place prerequisites before executable examples.
Primer / Published template
Developer API Reference Portal
A developer portal that combines conceptual guidance, navigable API reference, executable examples, and clear error documentation.
Prompt reference v1
Preview
Structure blueprint
Persistent documentation navigation frames a readable article column and an adjacent code example panel with language and response tabs.
Interaction
Behavior and access
All tabs follow keyboard tab patterns, copied code produces non-blocking feedback, deep links retain headings, and search results identify their reference section.
Implementation
Engineering boundaries
Render reference content on the server from a versioned contract. Mark code and output semantically, avoid embedding credentials in examples, and keep authentication guidance separate from sample values.
Design system
Primer token ledger
GitHub's open-source design system for productive developer interfaces.
Color roles
- model
- functional scales
- requiredRoles
- canvas, foreground, border, accent, success, danger
Typography
- approach
- interface and code typography
- requirements
- readable code, compact metadata
Spacing
- approach
- compact developer workflow
- baseUnitPx
- 4
Component rules
- code
- Separate code, output, and explanatory prose semantically.
- navigation
- Keep repository or product context visible.
Classification
Where this template fits
Categories
Styles
Industries
Technologies
Continue reading
Related templates
API Change Management Dashboard
A developer workspace for reviewing API versions, breaking changes, consumer impact, migration guidance, and rollout readiness.