Skip to content

docs: improve DESIGN-SYSTEM.md for agent consumption#34

Merged
cpascariello merged 3 commits intomainfrom
chore/design-system-doc-improvements
Mar 14, 2026
Merged

docs: improve DESIGN-SYSTEM.md for agent consumption#34
cpascariello merged 3 commits intomainfrom
chore/design-system-doc-improvements

Conversation

@cpascariello
Copy link
Copy Markdown
Collaborator

Summary

  • Add component index table and selection guide at the top of DESIGN-SYSTEM.md for fast agent lookup
  • Strip implementation internals (MutationObserver, ResizeObserver, clip-path curves) from component docs and relocate to ARCHITECTURE.md
  • Fix stale preview app route table (30 routes organized by category), remove redundant Breakpoints section
  • Codify consumer vs maintainer doc audience split in the "Adding a New Component" recipe and CLAUDE.md docs table

Test plan

  • npm run check passes (lint + typecheck + 267 tests)
  • Component Index anchor links resolve to correct headings
  • Preview app route table matches actual apps/preview/src/app/ structure

Add component index table and selection guide at the top for fast
lookup. Strip implementation internals (MutationObserver, ResizeObserver,
clip-path bezier curves) from component docs and relocate to
ARCHITECTURE.md. Fix stale preview app route table (30 routes organized
by category). Remove redundant Breakpoints section.
Update the "Adding a New Component" recipe in ARCHITECTURE.md to
clarify what goes where: DESIGN-SYSTEM.md is consumer-facing (usage,
props, variants), ARCHITECTURE.md is maintainer-facing (hooks,
observers, workarounds). Add DESIGN-SYSTEM.md to CLAUDE.md docs table
with the same distinction.
@cpascariello cpascariello merged commit e4f741c into main Mar 14, 2026
1 check passed
@cpascariello cpascariello deleted the chore/design-system-doc-improvements branch March 14, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant