{{ message }}
feat: add Iconography section to the DESIGN.md spec#112
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
Add a recognized, prose-focused `## Iconography` section between Shapes and Components in the spec, per proposal google-labs-code#101. Iconography is added to the canonical section order in spec-config.yaml, so CANONICAL_ORDER and the section-order rule pick it up automatically with no rule-code changes and no required icon token group (honoring the prose-focused direction). The spec.mdx prose prompts authors to cover the icon library/rationale, style variant, stroke/weight conventions, size scale, color rules, and mixing policy; docs/spec.md is regenerated via `bun run spec:gen`. The Unknown-section-heading example is updated from Iconography to Motion since Iconography is now recognized. The paws-and-paths example gains an illustrative prose-first Iconography section and still lints clean. Fixes google-labs-code#101
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a recognized, prose-focused
## Iconographysection to the DESIGN.md spec, positioned betweenShapesandComponents, per proposal #101 (building on #41 / #44).Why
Iconography is a universal facet of a design system, yet
## Iconographywas previously treated as an unknown section (it was literally the example of an unknown heading in the spec's Consumer Behavior table). Authors had no canonical place to document their icon library and conventions, and the linter could not order-check the section. Per PHILOSOPHY.md, the prose is where the design lives, so this section is added as prose-focused guidance rather than a new validated token group.Changes
spec-config.yaml: adds a singleIconographyentry to thesections:list betweenShapesandComponents. BecauseCANONICAL_ORDERand thesection-orderrule derive automatically from this config, the linter now recognizes and order-checks## Iconographywith no rule-code changes.spec-gen/spec.mdx: adds the prose block describing the section, consistent with the other prose-focused sections (Colors, Typography, Shapes). It prompts authors to cover the icon library and rationale, style variant, stroke/weight conventions, size scale, color rules, and mixing policy. The "Unknown section heading" example in the Consumer Behavior table is updated from## Iconographyto## Motion, since Iconography is now recognized.docs/spec.md: regenerated viabun run spec:gen(not hand-edited). The Section Order list now includes Iconography in position 7.examples/paws-and-paths/DESIGN.md: adds a short illustrative prose-first## Iconographysection between Shapes and Components.In keeping with PHILOSOPHY.md and the issue direction, this is intentionally prose-focused: no required
icons.*token group, no enum enforcement, and no icon-specific linter rules are introduced.Testing
bun testpasses (full suite; the existingspec-configandsection-ordertests are structural and required no changes).bun run spec:genis idempotent (--checkreports docs/spec.md up to date; re-running produces no drift).paws-and-pathsexample lints clean (0 errors, 0 warnings): an## Iconographyheading between Shapes and Components produces no section-order finding, while placing it out of order still triggers the existingsection-orderrule.Fixes #101