Skip to content

Adopt DESIGN.md format for visual identity documentation #1272

@EthanThatOneKid

Description

@EthanThatOneKid

proposal

Adopt the DESIGN.md format to document the acmcsuf.com visual identity in a machine-readable way.

why

DESIGN.md is a format spec that combines YAML front matter (design tokens) with markdown prose (design rationale). It lets AI coding agents understand a design system persistently and structurally — rather than inferring it from prose or screenshots.

For example, agents could:

  • Generate new UI components that match the brand automatically
  • Validate new designs against the brand tokens
  • Diff brand changes over time
  • Export tokens to Tailwind, Figma, or other tooling

what to add

A DESIGN.md file in the repo root covering:

  1. Colors — brand palette (primary, secondary, accent, neutral, etc.)
  2. Typography — font families, sizes, weights, line heights
  3. Spacing & rounded — scale tokens
  4. Components — button styles, form elements, etc.
  5. Prose sections — Overview, Do's and Don'ts, etc.

relevant links

next steps

  1. Audit the existing brand assets (CSS, Figma, docs) for token values
  2. Draft a DESIGN.md file
  3. Validate with npx @google/design.md lint DESIGN.md
  4. Optionally wire it into the CI to catch brand regressions

Would love feedback from the team on whether this fits the current workflow!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions