docs(icon): restore dropped dense best practice and straighten em dash - #4676
Open
josephfarina wants to merge 1 commit into
Open
docs(icon): restore dropped dense best practice and straighten em dash#4676josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
The English Icon docs gained a best-practices bullet in #4551 covering registerIcons/getExtendedIcon for library icon augmentation, but the docsDense overlay was not updated to match. Because the dense overlay merges by count and position, the missing bullet caused a silent 11-vs-10 parity gap: the dense CLI output dropped the augmentation guidance. Add the compressed dense bullet at the matching position so `astryx component Icon --lang dense` renders all 11 best practices with the same guidance flags as English. Also straighten one em dash in the English bullet to a colon per the doc prose style. Found during Night Watch doc review.
josephfarina
requested review from
cixzhang,
ejhammond and
imdreamrunner
as code owners
August 3, 2026 09:35
meta-cla
Bot
added
the
CLA Signed
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR Modified ComponentsIcon (@astryxdesign/core) · View in Storybook
Bundle Size Summary
Accessibility AuditStatus: 1 accessibility violation(s) found — 1 serious. Icon - 1 issue(s)
Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
cixzhang
reviewed
Aug 3, 2026
| description: 'Icons are small visual symbols that represent actions, objects, or concepts. They improve scannability and reinforce meaning alongside text. Supports both direct SVG components and semantic icon names that adapt to the active theme.', | ||
| bestPractices: [ | ||
| { guidance: true, description: 'Use semantic icon names when available; they adapt to theme changes automatically.' }, | ||
| { guidance: true, description: 'Libraries can augment the icon map with their own keys: registerIcons({\'richtext:bold\': <MyIcon />}) accepts arbitrary keys (not just IconName). Resolve via getExtendedIcon(key, fallback), which prefers a theme-registered icon and falls back to a bundled default: the seam that makes library icons theme-overridable.' }, |
Contributor
There was a problem hiding this comment.
The preferred way to do this is via theme
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
2 participants
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.
What
The English Icon
docs.usage.bestPracticesgained a bullet in #4551 coveringregisterIcons/getExtendedIconfor library icon augmentation, but thedocsDenseoverlay was never updated to match. The dense overlay merges best practices by count and position, so the missing bullet produced a silent 11-vs-10 parity gap:astryx component Icon --lang densedropped the augmentation guidance entirely.This adds the compressed dense bullet at the matching position (after the "use semantic icon names" bullet, guidance: true) so the dense output renders all 11 best practices with the same guidance flags and order as English. It also straightens one em dash to a colon in the English bullet, matching the doc prose style.
No prop, param, or return coverage changed. The edit is confined to the
bestPracticesarrays and does not overlap the Icon prop-doc edits in #4647, #4648, or #4505.Validation
pnpm --filter @astryxdesign/core typecheck:docspassespnpm exec tsc --project packages/cli/tsconfig.template-docs.json --noEmitpassesastryx component Icon --lang denserenders 11 best practices, single(required)marker, consistent formattingNight Watch — Doc Reviewer