doc: add impacted features/adapters tags to changelog - #1488
Draft
franky47 wants to merge 13 commits into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Reuses GitHub's Primer label formula (solid chip + contrast-flipped text in light, translucent fill + lightened text in dark) so the badges match what maintainers see on the repo. Colors are presentation-only and live docs-side.
Solid GitHub-style chips cannot reach 7:1 on mid-tone label colors, so both themes now use a tinted chip with the text walked along the label's hue until it provably clears WCAG AAA — precomputed and unit-tested per palette entry, with a visibility floor on borders for labels near the page background. Unmapped labels now warn in build logs, and a parity test ties the color map to the codec's display-name vocabulary.
The render-side re-filter guards against triage labels smuggled in through hand-edited release bodies; without a test, simplifying it away would pass the suite while leaking those labels onto rendered surfaces.
Driven by the codec taxonomy so the showcase cannot drift from the real label vocabulary as it grows on GitHub.
The Next.js/Vercel brand guidelines are strictly black & white; the 18% tint grayed those chips out, reading as off-brand in light mode.
Review found two silent data drops: out-of-taxonomy labels vanished from rendered surfaces without a trace, and the GraphQL query could truncate a heavily-labelled PR. Also pins the published schema keeping labels optional.
The precomputed WCAG color math was overkill shipped to the client: contrast is a review/test concern. A Record of Tailwind classes on the existing shadcn Badge does the same job with a tenth of the code.
A typed union of known labels replaces the runtime key-parity test: Record<KnownImpactLabel, string> makes drift a type error instead of a test failure, and the satisfies bound keeps keys inside the taxonomy.
The design-system MDX page enumerates the vocabulary, and MDX imports are invisible to tsc — only the docs build catches a missing export.
The prefix filter brought no value: a new prefixed label on GitHub would still need a display name and badge class to render properly. A single as-const array now drives membership, display order, and the union that forces both maps to stay complete, so the raw-name/gray-badge fallback machinery goes away.
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.
No description provided.