docs: design guidelines + LLM design-generator prompt by kalil0321 · Pull Request #91 · kalil0321/reverse-api-engineer

kalil0321 · 2026-06-01T05:02:34Z

Summary

Adds a design/ folder at the repo root capturing the approach behind the marketing site and its /lab playground, so the same quality can be reproduced — by people or by another LLM.

design/
├── README.md          — the methodology: the "AI-slop" problem, 10 principles, the lab process
├── design-system.md   — the opinionated usage layer on rae's system (rules of use, not raw tokens)
├── PROMPT.md          — a paste-into-any-LLM prompt that generates /lab-style variant galleries
└── examples.md        — case study: the real M/S/A variant galleries and why the split-flap board won

No duplication with `System_Design.md`

System_Design.md stays the canonical token/asset reference (exact palette, fonts + Fraunces axes, icon inventory, shapes). design/design-system.md deliberately does not repeat those tables — it links to System_Design.md and adds only the judgement layer on top (palette discipline, the asterisk motif, neo-brutalist shadows, motion rules, the no-lucide-on-brand stance).

Note on `.gitignore`

The root .gitignore has a broad prompt*.md rule (for stray scratch files) that was hiding design/PROMPT.md; added a !design/PROMPT.md negation so the committed prompt is tracked.

The core idea

Concept first (name a physical-world metaphor in ≤3 words) → explore wide in a throwaway lab → select ruthlessly → polish the winner. That "generate many, keep few" loop is what produced the split-flap departure board.

🤖 Generated with Claude Code

Summary by cubic

Adds a design/ docs folder capturing the site’s design methodology, an opinionated usage layer on top of System_Design.md, a paste-ready LLM prompt for generating /lab-style variant galleries, and worked examples. Also updates .gitignore to ensure design/PROMPT.md is tracked despite a broad prompt*.md rule.

^{Written for commit 543984a. Summary will update on new commits.}

Greptile Summary

This PR adds a design/ folder with four documentation files capturing the design methodology and tooling behind the rae marketing site, plus a .gitignore negation so the committed prompt file isn't hidden by the existing prompt*.md exclusion rule.

design/README.md + design/design-system.md: methodology (10 principles, 5-step lab process) and the opinionated usage rules on top of the canonical System_Design.md; the two files are cleanly scoped and do not duplicate the raw token reference.
design/PROMPT.md: a paste-ready LLM prompt for generating variant galleries, with clear {{...}} placeholders and explicit hard rules against generic output.
design/examples.md: a worked case study of the three section explorations (marquee, how-it-works, works-with-agents) showing which variants shipped and why.

Confidence Score: 5/5

Documentation-only change with no functional code — safe to merge.

All five changed files are markdown or .gitignore. The cross-file references (to ../System_Design.md, component paths) point to existing files. The .gitignore negation is correctly placed after the pattern it overrides and is harmless on case-sensitive systems.

No files require special attention.

Important Files Changed

Filename	Overview
.gitignore	Adds a `!design/PROMPT.md` negation to prevent the repo-wide `prompt*.md` exclusion rule from hiding the newly committed prompt file.
design/PROMPT.md	New LLM prompt template for generating variant-gallery UI designs; well-structured with clear placeholder conventions and a full set of hard rules to avoid generic output.
design/README.md	New design-methodology document covering the 10 principles and five-step process; correctly references `../System_Design.md` (which exists) and avoids duplicating it.
design/design-system.md	New opinionated usage layer for the rae design system; links back to the canonical `System_Design.md` and adds palette discipline, motion rules, and iconography stance without duplicating raw tokens.
design/examples.md	New case-study document covering three section explorations (feature marquee, how-it-works, works-with-agents) with variant tables, shipped decisions, and extracted lessons.

_{Reviews (1): Last reviewed commit: "docs(design): add PROMPT.md (un-ignore f..." | Re-trigger Greptile}

Capture the methodology behind the marketing site and its /lab playground so the same quality can be reproduced by people or other LLMs. - README.md — the methodology: the "AI-slop" problem, 10 principles, the generate-many-keep-few lab process. - design-system.md — the opinionated usage layer on top of the rae system (palette discipline, the asterisk motif, neo-brutalist shadows, motion, the no-lucide-on-brand stance). Points to the existing System_Design.md as the canonical token/asset reference rather than duplicating it. - PROMPT.md — a paste-into-any-LLM prompt that generates a /lab-style gallery of named, concept-different variants for one section at a time. - examples.md — worked case study: the real M/S/A variant galleries and why the split-flap board won. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

The root .gitignore's `prompt*.md` rule was hiding design/PROMPT.md; add a negation so the committed generator prompt is tracked. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

kind-agent · 2026-06-01T05:02:40Z