agentleFS
RevealUIStudioRevealUIStudio/revskills/skills/revealui-design/CLAUDE.md

revskills / revealui-design

CLAUDE.md2 starsChanged 52 days agoMITView on GitHub

Before ANY visual / UI / copy / brand decision, read these in order: The Babel JSX kits (NavBar, Hero, Sidebar, and the rest) are retired. Each index.html is a pointer page and does not inline cobalt tokens. For production work, read token values from @revealui/tokens/design-context/. That pack is authoritative and drift-gated by CI. Five companion audits were produced as part of the May 2026 assessment pass. The summaries below capture what you need to know without having access to…

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this CLAUDE.md into the rules it gives an agent

7 rules. About 0 are common, 3 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before ANY visual / UI / copy / brand decision, read these in order:

    line 11
  2. Very specific:

    Every file in the source bundle's assets/ predates Cobalt and uses non-brand palettes (rainbow medallion, indigo text logo, orange stencil …

    line 68
  3. Very specific:

    If you need a logo, render the proposed mark inline: cobalt rounded-square (#003E7A) with "R" in Inter Tight 800, amber dot (#f0b519) at …

    line 69
  4. Distinctive:

    No OG / social card image exists yet — flag if your work needs one.

    line 70
  5. Very specific:

    Test-mode / draft amber chip: rgba(240,181,25,0.16) bg + #f5d278 text.

    line 76
  6. Very specific:

    When designing marketing (especially /):

    line 108
  7. Distinctive:

    Never write a hex literal in component code: If the value doesn't exist as a token, add the token first.

    line 122

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

RevealUI Design System — Claude Code context

State as of bundle date

  • Brand: Cobalt v4 (May 2026). Brand hue oklch(0.36 0.190 240) / #003E7A on paper, oklch(0.58 0.150 240) on dark (AA-compliant — lifted in shipped code, contrast issue RESOLVED). Accent: Solar Amber oklch(0.80 0.165 85) / #f0b519.
  • Type: Inter (body), Inter Tight (display, 800 weight, -0.02em tracking), JetBrains Mono (code, ligatures OFF).
  • Tokens: dark-first OKLCH, namespace --rvui-*, dark/light flip via [data-theme] + prefers-color-scheme. shadcn bridge in place (--primary, --ring, etc. alias to --rvui-*).

Discovery order (always do this first)

Before ANY visual / UI / copy / brand decision, read these in order:

  1. README.md (this skill) — canonical state. Branding, voice, primitives, sections.
  2. @revealui/tokens/design-context/ — the canonical token pack. A committed, CI-drift-gated pack generated from packages/tokens/src/tokens.css in the revealui repo / published @revealui/tokens package. This is the source of truth for color, type, motion, and radii. Read tokens from this pack; never trust a local snapshot.
  3. SKILL.md (this skill) — short orientation. Brand is Cobalt; README + the design-context pack supersede any stale values.

What's in this skill

revealui-design/
├── CLAUDE.md                          — you are here
├── README.md                          — full canonical doc (start here)
├── SKILL.md                           — short orientation
└── ui_kits/
    ├── marketing/                     — retirement pointer (GAP-479)
    │   ├── README.md
    │   └── index.html                 — pointer page, no tokens, no JSX
    └── admin/                         — retirement pointer (GAP-479)
        ├── README.md
        └── index.html                 — pointer page, no tokens, no JSX

Canonical tokens (not in this skill — read from the package):
  @revealui/tokens/design-context/

The Babel JSX kits (NavBar, Hero, Sidebar, and the rest) are retired. Each index.html is a pointer page and does not inline cobalt tokens. For production work, read token values from @revealui/tokens/design-context/. That pack is authoritative and drift-gated by CI.

Open issues — work around these, don't reintroduce them

Five companion audits were produced as part of the May 2026 assessment pass. The summaries below capture what you need to know without having access to the HTML files themselves.

Contrast & Accessibility — 5 WCAG issues remaining

  • Dark-mode brand color (RESOLVED in shipped code). The shipped token is oklch(0.58 0.150 240) — lifted for AA on dark surfaces. Do not use the old value oklch(0.46 0.180 240).
  • Warning text on paper fails AA. --rvui-warning = #d39a08 tests at 2.39 on paper. Use #8a6010 (amber-700) for warning text; reserve #d39a08 for chip backgrounds with dark text.
  • Smoke-300 as text fails AA. --rvui-text-2 = #8298b3 tests at 2.83 — only safe as icon/separator/border, not as text. For tertiary text use #4f6580 (smoke-500).
  • Status colors on dark are AA-large only. Success (3.57), error (3.05) on midnight — only safe for ≥18pt/14pt-bold text. Use the -subtle variants for background fills with dark text, or lift the foregrounds.

Dark-Mode Sweep — 24 preview cards graded

  • 9 flip cleanly, 8 flip partially, 7 ignore the toggle entirely.
  • Root cause is hard-coded Tailwind-flavored greys instead of tokens. Substitution table:

    Hard-codedToken to use instead
    #1f2937 / #0c181e / #0a0e1avar(--mkt-fg) or var(--rvui-text-0)
    #374151 / #4b5563var(--mkt-fg-body)
    #6b7280 / #6b7d96var(--mkt-fg-muted)
    #9ca3af / #d1d5dbvar(--mkt-fg-subtle)
    #ffffff / #fff (as surface)var(--mkt-bg) or var(--rvui-surface-1)
    #f9fafb / #f3f4f6 / #fafbfcvar(--mkt-bg-subtle)
    #e5e7eb (as border)var(--mkt-border)

    NEVER write hex literals for these greys in new code.

Logos & Lockups — asset folder is off-brand

  • Every file in the source bundle's assets/ predates Cobalt and uses non-brand palettes (rainbow medallion, indigo text logo, orange stencil wordmark, slate favicon).
  • If you need a logo, render the proposed mark inline: cobalt rounded-square (#003E7A) with "R" in Inter Tight 800, amber dot (#f0b519) at bottom-right with paper ring. Don't reference the asset files until they're regenerated.
  • No OG / social card image exists yet — flag if your work needs one.

Applied Artifacts — patterns the DS holds

Across 10 dogfooded artifacts, these patterns are universal and you should reuse them:

  • Brand glyph in nav: 22×22 cobalt rounded-square, "R" in Inter Tight 800.
  • Test-mode / draft amber chip: rgba(240,181,25,0.16) bg + #f5d278 text.
  • Brand → amber avatar gradient — ONE per surface, max.
  • Right arrow (→) in CTA links — unicode glyph, not SVG.
  • Checkmarks always inline SVG, never ✓.
  • Sticky nav with backdrop-blur(12px) is the ONLY place blur appears.

Microcopy — string library status

  • Canonical CTA is "Start free" — not design-partner or early-access phrasing on the technical hero.
  • "Your role can't do that" is anti-pattern phrasing. Use "This action needs the admin role" — blame the action, not the user identity.
  • Missing categories (build before consuming): success & confirmations, destructive flows, loading & in-flight, agent-specific.

Voice & content rules (non-negotiable)

RuleDetail
No emoji, anywhereCheckmarks/close icons are always inline SVG
No em dashes in copyHardline; use sentences or commas
Sentence case for headingsh1, h2, section titles. Title case only for proper nouns + nav labels
ALL CAPS only for eyebrowsAt 0.20em letter-spacing, 11–12px size, brand color or smoke-500
Second person for the userFirst-person plural ("we") only in legal/contact contexts
Operational verbsbuild, run, ship, deploy, wire, save, publish. Never revolutionize / supercharge / unleash / empower
Brand casingRevealUI in prose. REVEALUI only for legal entity. Rev-prefix camel for sub-products (RevDev, RevForge)
Primitives vocabularyPeople, Content, Offers, Payments, Agents (never Users/Products/Intelligence on marketing)
Honest about statusStripe in test mode? Say so. Component preview? Say so. Don't hide pre-launch state
Canonical CTAs"Start free", "See Pro pricing", "Talk to us" — never "Buy now" or "Subscribe"
Numbers stay numeric"60 seconds", not "sixty seconds"
Code names in backticksnpx create-revealui@latest, --rvui-brand
Status terms in **bold****Pro**, **TEST mode**, **preview** — never colored pills outside admin UI

Marketing craft bar (homepage)

When designing marketing (especially /):

  1. Max 7 sections; hero ≤2 CTAs.
  2. Signature moment = receipt, not multi-blob gradients.
  3. Problem = capability stack (aligned type columns). Never spreadsheet tables or mobile matrix cards.
  4. Product-as-proof = live frame / product mat; no stale screenshots.
  5. Pricing teaser: paper cards + quiet Recommended chip; never inverted black Pro card.
  6. Code over docs: if this skill and apps/marketing disagree, code wins, then update this skill.

Token usage rules

  • Reach for var(--rvui-*) first. Use shadcn bridge (--primary, --ring, etc.) where component code expects it.
  • --mkt-* is a back-compat layer aliased to --rvui-* — don't author new code against it; existing code continues to work.
  • Tailwind utility classes: marketing app aliases emerald-* to cobalt and gray-* to smoke. Existing utilities (text-emerald-700, bg-gray-50) resolve to cobalt/smoke and are fine; don't add new emerald-* utilities — use cobalt-* semantic names if introducing new ones.
  • Never write a hex literal in component code. If the value doesn't exist as a token, add the token first.

Before you make a change

State out loud:

  1. Which DS files you read.
  2. Which tokens / components you're consuming (from the design-context pack).
  3. Whether your change crosses any of the five open issues above.
  4. Voice/copy rules being applied (if copy is involved).

Then proceed.


Bundled from the RevealUI Design System project, including the May 19, 2026 assessment pass (6 audit artifacts). Token source: @revealui/tokens/design-context/ (committed, CI-drift-gated).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.