Skip to content

Commit 2fecc01

Browse files
committed
Add design context to CLAUDE.md
1 parent bcec636 commit 2fecc01

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CLAUDE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,30 @@ Please refer to `AGENTS.md` for comprehensive project documentation, including:
1010
- CI/CD information
1111

1212
All project-specific instructions and guidelines are maintained in `AGENTS.md`.
13+
14+
## Design Context
15+
16+
**Personality:** Minimal, focused, fast. A well-organized reference tool — never decorative, never in the way.
17+
18+
**References:** Elixir HexDocs, Tailwind CSS v2 docs. **Anti-references:** busy enterprise docs, heavy drop shadows, ornamental borders.
19+
20+
### Design Principles
21+
22+
1. **Types are equal partners** — Type signatures are as important as method names. Immediately visible, not hidden metadata.
23+
2. **Hierarchy through typography, not decoration** — Font size, weight, color. No badges, pills, or ornamental borders for structural info. Let whitespace do the heavy lifting.
24+
3. **Code is the content** — Method names, params, and types all use `--font-code`. Don't mix prose typography into code contexts.
25+
4. **Scan-first design** — Method entries parseable at a glance: name → type → description. Each layer visually distinct.
26+
5. **Respect the design system** — Use CSS custom properties exclusively. No hardcoded values. Dark mode and themes must work automatically.
27+
28+
### Design Tokens (Aliki Theme)
29+
30+
| Token | Light | Dark | Usage |
31+
|-------|-------|------|-------|
32+
| `--color-text-primary` | `#1c1917` | `#fafaf9` | Method names, headings |
33+
| `--color-text-secondary` | `#57534e` | `#e7e5e4` | Type signatures, descriptions |
34+
| `--color-text-tertiary` | `#78716c` | `#a8a29e` | De-emphasized metadata |
35+
| `--font-code` | ui-monospace stack | same | All code: names, params, types |
36+
| `--font-size-lg` | 18px | same | Method headings |
37+
| `--font-size-sm` | 14px | same | Type signatures |
38+
| `--font-size-xs` | 12px | same | Metadata, labels |
39+
| `--space-1` to `--space-6` | 4px–24px | same | All spacing |

0 commit comments

Comments
 (0)