Skip to content

docs: add DESIGN.md describing Orca's visual identity#981

Open
nwparker wants to merge 1 commit intomainfrom
nwparker/design.md
Open

docs: add DESIGN.md describing Orca's visual identity#981
nwparker wants to merge 1 commit intomainfrom
nwparker/design.md

Conversation

@nwparker
Copy link
Copy Markdown
Contributor

Summary

  • Adds a DESIGN.md at the repo root following the google-labs-code/design.md alpha spec, so agents and contributors have a single structured source of truth for Orca's tokens and design rationale.
  • Tokens are derived from src/renderer/src/assets/main.css and the Button CVA in src/renderer/src/components/ui/button.tsx; prose covers colors, typography, layout, elevation, shapes, component anatomy (titlebar agent badge, sidebar, buttons, diff comments, scrollbars), and do's/don'ts.
  • Tightens two a11y-failing values to meet WCAG AA and non-text 3:1 contrast: muted-foreground #737373 → #6B6B6B (~4.89:1 on muted) and ring #a1a1a1 → #8E8E8E (~3.28:1 on background). An inline a11y note flags these as the normative target the CSS variables should be aligned to.
  • Includes a parallel dark-colors: block so a build script can emit .dark CSS variables without re-parsing the prose.

Validation

  • npx @google/design.md lint DESIGN.md0 errors, 20 warnings, 1 info. All warnings are orphaned-tokens for semantic colors consumed directly by CSS / Monaco / the git-decoration layer (not via the components map), which is expected.

Test plan

  • Open DESIGN.md and confirm section order matches the spec (Overview → Colors → Typography → Layout → Elevation → Shapes → Components → Do's and Don'ts).
  • Spot-check that component-token values (button-primary, sidebar, input, card, etc.) correspond to the shadcn components in src/renderer/src/components/ui/.
  • Confirm dark-mode values in dark-colors: match the .dark block in src/renderer/src/assets/main.css.
  • (Follow-up, separate PR) Update --muted-foreground and --ring in main.css to match the normative DESIGN.md values so runtime UI also clears WCAG AA / non-text 3:1.

Adds a DESIGN.md following the google-labs-code/design.md alpha spec so
agents and contributors have a single structured source of truth for
Orca's tokens (colors, typography, rounded, spacing, components) and the
prose rationale for when and how to apply them.

Tokens are derived from src/renderer/src/assets/main.css and the Button
CVA in src/renderer/src/components/ui/button.tsx, with a parallel
dark-colors block for the .dark theme remap. Tightens muted-foreground
(#737373 -> #6B6B6B) and ring (#a1a1a1 -> #8E8E8E) to the WCAG AA /
non-text 3:1 thresholds; an a11y note flags these as the normative
target for the CSS variables.

Passes the official `npx @google/design.md lint` with 0 errors.
@nwparker
Copy link
Copy Markdown
Contributor Author

This is a bit long IMO, I prob will try to slim it down before merge.

@nwparker nwparker added the size/l Large PR (≤2500 added lines, ≤50 files) label Apr 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/l Large PR (≤2500 added lines, ≤50 files)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant