docs(Avatar): restore the missing dense best-practice bullet - #5330
Open
josephfarina wants to merge 1 commit into
Open
docs(Avatar): restore the missing dense best-practice bullet#5330josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
The English docs list eight best practices; docsDense had seven. The 'do not name an interactive avatar with a status label' anti-pattern was folded into the interactive-avatar bullet, dropping its own position and its guidance:false flag. Split it back out so dense matches English 1:1 in count and guidance flag per position. Found during Night Watch doc review. Night Watch — Doc Reviewer
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR Modified ComponentsAvatar (@astryxdesign/core) · View in Storybook
Bundle Size Summary
Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
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.
What
The English Avatar docs list eight best practices;
docsDensehad only seven. The "do not name an interactive avatar with a status label" anti-pattern (guidance:false) had been folded onto the end of the interactive-avatar bullet (guidance:true), which dropped its own position and its guidance flag. The dense compression protocol requires 1:1 count parity with English, matching the guidance flag at each position, and never packing two English bullets into one.Split the anti-pattern back into its own guidance:false bullet. Dense now matches English 8/8 with the same guidance sequence (true x5, false x3).
Checks
pnpm --filter @astryxdesign/core typecheck:docspassesastryx component Avatar --lang denserenders eight best practices, five Do and three Don'tNight Watch — Doc Reviewer