Docs/badge guide - #263
Conversation
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults 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:
📝 WalkthroughWalkthroughAdds Badge usage and code documentation, registers Badge in component navigation, documents Pill deprecation in favor of label Badges, and increases the Checkbox validation playground height. ChangesBadge documentation
Checkbox documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces the initial documentation structure and an ideation draft for the new Badge component, registering it in the sidebar. The review feedback highlights that several files still contain 'to be done' placeholders that need to be populated before merging, including integrating the draft content into the usage guide and defining the API properties. Additionally, the reviewer noted a couple of typos in the ideation draft and requested reordering the sidebar entry alphabetically to maintain consistency.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
EIX-59 |
Added code, guide, index files and adapted sidebar.ts
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
3e36347 to
777251f
Compare
kathrinschalber
left a comment
kathrinschalber
left a comment
There was a problem hiding this comment.
A couple questions to discuss :)
Co-authored-by: Kathrin <123640803+kathrinschalber@users.noreply.github.com>
Refine badge component documentation with improved clarity and restructured content. Reorganize badge component earlier in the 'System feedback and status' section of the sidebar. Remove draft ideation document and production environment configuration file.
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/components/badge/guide.md`:
- Around line 85-89: Remove the shorter duplicate synchronization bullet from
the badge guidance list, keeping the more detailed “Keep badges synchronized
with the underlying notification state” entry and its additional update/removal
guidance unchanged.
- Line 75: Update the badge behavior paragraph to remove the ambiguous “enabled”
and “disabled” terminology; explicitly describe pulsing as conditional on the
Pulse animation option, or remove the pulsing sentence if that option is not
documented here.
- Line 82: Update the counter-label guidance in the Dos list to mention the same
short-word exception allowed by the Types section, while retaining the two-digit
integer limit and 99+ overflow behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 3a791c88-2e08-4942-b210-226a92508a87
⛔ Files ignored due to path filters (4)
static/figma/wEptRgAezDU1z80Cn3eZ0o_8141_4052.pngis excluded by!**/*.pngstatic/figma/wEptRgAezDU1z80Cn3eZ0o_8141_4066.pngis excluded by!**/*.pngstatic/figma/wEptRgAezDU1z80Cn3eZ0o_8161_118.pngis excluded by!**/*.pngstatic/figma/wEptRgAezDU1z80Cn3eZ0o_8173_214.pngis excluded by!**/*.png
📒 Files selected for processing (8)
docs/components/badge/code.mdxdocs/components/badge/guide.mddocs/components/badge/index.mdxdocs/components/checkbox/code.mdxdocs/components/overview.mddocs/components/pill/code.mdxdocs/components/pill/guide.mdsidebars.ts
Updates badge guidance in docs/components/badge/guide.md: clarifies that pulse animation loops continuously until explicitly disabled and may be hidden by some a11y browser configurations; removes the incorrect statement that badges pulse by default in the States section; refines Dos by allowing short words (e.g. "new") for counters, adds an example for keeping badges synchronized with notification state, and removes a duplicated synchronization line. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
3 participants
💡 What is the current behavior?
GitHub Issue Number: #
🆕 What is the new behavior?
Added the usage guide including code spec for badges
👨💻 Help & support
Summary by CodeRabbit
New Features
Documentation