docs(i18n): backfill docsDense bestPractices for InternationalizationProvider#4323
Merged
Merged
Conversation
…Provider The English docs added four bestPractices bullets in #4294, but the docsDense overlay only carried usage.description and propDescriptions. The loader silently fell back to the English bullets, so dense output was not compressed. Add the four dense bullets, matching English order and guidance flags. Found during Night Watch doc review.
josephfarina
requested review from
cixzhang,
ejhammond and
imdreamrunner
as code owners
July 25, 2026 09:13
|
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 Componentsi18n
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
docsforInternationalizationProvidergained fourusage.bestPracticesbullets in #4294, but thedocsDenseoverlay only carriedusage.descriptionandpropDescriptions. The CLI loader (mergeTranslation) silently falls back to the English bullets when the overlay omits them, soastryx component InternationalizationProvider --lang densewas serving uncompressed guidance.This adds the four dense bullets to
docsDense.usage.bestPractices, matching the English count, order, and per-positionguidanceflag.Validation
pnpm --filter @astryxdesign/core typecheck:docspassespnpm exec tsc --project packages/cli/tsconfig.template-docs.json --noEmitpassesnode .github/scripts/api-cli-parity-test.mjs --no-baseline: 330 pass, 0 failastryx component InternationalizationProvider --lang denserenders the four dense bullets with single(required)markersNight Watch — Doc Reviewer