DESIGN.md

Technical documentation portal

Readable long-form documentation with persistent navigation, code, and clear information boundaries.

Revision: 1
Verified: 2026-07-26

Save or explore

#documentation #api #code

Compatibility and paths

GenericProject convention; requires an explicit reference.

CodexDESIGN.mdReference it from AGENTS.md.

Claude CodeDESIGN.mdImport it from CLAUDE.md.

Gemini CLIDESIGN.mdReference it from GEMINI.md.

Trust and provenance

Curated record reviewed 2026-07-26. Results still depend on the supplied context and target environment.

Live preset preview

See the design before you give it to an agent

This sandboxed preview is rendered directly from the same DesignBrief embedded in the downloadable DESIGN.md.

Customize

What this preset defines

The file gives an agent concrete design constraints instead of a vague request to “make it look good.”

Product: documentation
Layout archetype: documentation
Density: comfortable
Base radius: 4px
Type scale: 1.2

background#111318surface#191c22text#f5f5f5muted#a7a7a7accent#75beffsuccess#89d185warning#dcdcaadanger#f48771

Required layout sections

Documentation header
Table of contents
Article content
Code examples
API reference
Next steps

How to use it

The preset is useful without AI and does not execute code.

01
Preview and customize
Check desktop and mobile, then open the visual builder if the palette, typography, spacing, or sections need adjustment.
02
Download DESIGN.md
Save it in the repository root. It contains readable design rules plus the versioned machine-readable DesignBrief.
03
Connect your agent
Add the generated integration snippet to AGENTS.md, CLAUDE.md, or GEMINI.md so the agent explicitly reads the design system.

DESIGN.md is a OneLiners convention. The included integration file explains exactly how to use it with your selected agent.

Export pack

Start with DESIGN.md, then take only the extras you need

The main download is human-readable Markdown. JSON is available only as an optional design-token file.

Agent integration

DESIGN.md

Product direction, semantic palette, typography, layout, responsive behavior, accessibility, and an importable DesignBrief.

3457 bytes · Markdown

Download DESIGN.md

View generated DESIGN.md

# Technical documentation portal

## Product direction

- **Page type:** documentation
- **Layout archetype:** documentation
- **Audience:** Developers integrating an API
- **Goal:** Move readers from concept to verified implementation.
- **Tone:** Authoritative, explanatory, and practical

## Visual system

- Use the semantic palette below; never use color without meaning.
- Heading: Inter, ui-sans-serif, system-ui, sans-serif; body: Inter, ui-sans-serif, system-ui, sans-serif; code: JetBrains Mono, ui-monospace, monospace.
- Density is comfortable; base radius is 4px; shadows are subtle.
- Icons: Lucide-style outline icons with consistent 1.75px strokes.
- Imagery: Use product-specific imagery only when it explains the workflow; never use decorative filler..

## Semantic palette

| Role | Value | Intended use |
| --- | --- | --- |
| Background | `#111318` | Page canvas and the deepest application layer |
| Surface | `#191c22` | Cards, panels, navigation, and raised regions |
| Text | `#f5f5f5` | Primary copy, labels, and high-emphasis content |
| Muted | `#a7a7a7` | Secondary copy, metadata, and inactive controls |
| Accent | `#75beff` | Primary actions, focus, selection, and active state |
| Success | `#89d185` | Confirmed success and healthy state |
| Warning | `#dcdcaa` | Caution, pending review, and non-blocking risk |
| Danger | `#f48771` | Errors, destructive actions, and blocking risk |

The optional `design-tokens.css` from the full export pack mirrors these values. This `DESIGN.md` remains complete when used on its own.

## Layout and content

1. Documentation header
2. Table of contents
3. Article content
4. Code examples
5. API reference
6. Next steps

## Responsive and accessibility

- Collapse sidebars into an explicit drawer and preserve the primary task before secondary metadata..
- Meet WCAG AA contrast, preserve visible focus, and respect reduced motion.
- Do not reduce essential content or actions on mobile.

## Machine-readable OneLiners DesignBrief

<!-- oneliners-design-brief:v1 -->
```json
{
  "schemaVersion": "1",
  "name": "Technical documentation portal",
  "pageType": "documentation",
  "layoutStyle": "documentation",
  "audience": "Developers integrating an API",
  "goal": "Move readers from concept to verified implementation.",
  "tone": "Authoritative, explanatory, and practical",
  "palette": {
    "background": "#111318",
    "surface": "#191c22",
    "text": "#f5f5f5",
    "muted": "#a7a7a7",
    "accent": "#75beff",
    "success": "#89d185",
    "warning": "#dcdcaa",
    "danger": "#f48771"
  },
  "typography": {
    "heading": "Inter, ui-sans-serif, system-ui, sans-serif",
    "body": "Inter, ui-sans-serif, system-ui, sans-serif",
    "mono": "JetBrains Mono, ui-monospace, monospace",
    "baseSize": 16,
    "scale": 1.2
  },
  "density": "comfortable",
  "radius": 4,
  "shadow": "subtle",
  "sections": [
    "Documentation header",
    "Table of contents",
    "Article content",
    "Code examples",
    "API reference",
    "Next steps"
  ],
  "iconStyle": "Lucide-style outline icons with consistent 1.75px strokes",
  "imagery": "Use product-specific imagery only when it explains the workflow; never use decorative filler.",
  "mobileStrategy": "Collapse sidebars into an explicit drawer and preserve the primary task before secondary metadata.",
  "accessibility": {
    "contrastTarget": "WCAG AA",
    "reducedMotion": true,
    "visibleFocus": true
  }
}
```

Real example

Input

documentation: Move readers from concept to verified implementation.

Expected result

A comfortable documentation using #75beff as the semantic accent and 6 defined sections.

Source evidence

Web Content Accessibility Guidelines 2.2official MDN responsive designofficial