docs(*): add missing component API links#253
Conversation
WalkthroughExpanded the docs navigation to add new component entries: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #253 +/- ##
==========================================
- Coverage 96.95% 93.16% -3.79%
==========================================
Files 70 149 +79
Lines 1542 2617 +1075
Branches 150 392 +242
==========================================
+ Hits 1495 2438 +943
- Misses 28 94 +66
- Partials 19 85 +66 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1)
73-73: Prefer unbound generics in nameof for resilience.Using
nameof(Type<>)avoids relying on an in-scopeTand matches the canonical pattern.Apply:
- .Add( new( nameof( LumexDataGrid<T> ) ) ) + .Add( new( nameof( LumexDataGrid<> ) ) ) @@ - .Add( new( nameof( LumexRadio<T> ) ) ) - .Add( new( nameof( LumexRadioGroup<T> ) ) ) + .Add( new( nameof( LumexRadio<> ) ) ) + .Add( new( nameof( LumexRadioGroup<> ) ) )Optionally, align earlier entries (e.g.,
LumexListbox<T>,LumexNumbox<T>,LumexSelect<T>) to the same style in a follow-up.Also applies to: 98-98, 99-99
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs(3 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (4)
src/LumexUI/Components/Code/LumexCode.razor.cs (2)
LumexCode(17-84)LumexCode(53-56)src/LumexUI/Components/DataGrid/LumexDataGrid.razor.cs (1)
LumexDataGrid(220-244)src/LumexUI/Components/Dropdown/LumexDropdown.razor.cs (2)
LumexDropdown(15-44)LumexDropdown(24-29)src/LumexUI/Components/Kbd/LumexKbd.razor.cs (2)
LumexKbd(17-67)LumexKbd(39-42)
🔇 Additional comments (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1)
57-57: LGTM: Added missing Components API entries.The new links for Alert, Badge, Code, DataGrid, DropdownTrigger, Kbd, Radio, and RadioGroup are consistent with existing component names and placement. No behavior risks.
Also applies to: 61-61, 70-70, 73-73, 80-80, 83-83, 98-98, 99-99
| new NavigationCategory( "Components API" ) | ||
| .Add( new( nameof( LumexAccordion ) ) ) | ||
| .Add( new( nameof( LumexAccordionItem ) ) ) | ||
| .Add( new( nameof( LumexAlert ) ) ) |
There was a problem hiding this comment.
🧩 Analysis chain
Quick sanity check: components exist and nav isn’t duplicating entries.
Please verify the component types exist and each appears once in the nav.
Also applies to: 61-61, 70-70, 73-73, 80-80, 83-83, 98-98, 99-99
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Check component type definitions exist:"
rg -nP --type=cs -C0 $'\\b(partial\\s+)?class\\s+Lumex(Alert|Badge|Code|Kbd)\\b|\\bclass\\s+Lumex(DataGrid|Radio|RadioGroup)\\s*<' src || true
rg -nP --type=cs -C0 $'\\bclass\\s+LumexDropdownTrigger\\b' src || true
echo
echo "Ensure single nav entry per component:"
targets=(
'LumexAlert' 'LumexBadge' 'LumexCode' 'LumexDataGrid' 'LumexDropdownTrigger'
'LumexKbd' 'LumexRadio' 'LumexRadioGroup'
)
for t in "${targets[@]}"; do
echo -n "$t: "
rg -n "nameof\\(\\s*${t}(<[^>]*>)?\\s*\\)" docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs | wc -l
doneLength of output: 1251
Duplicate navigation entries in NavigationStore.cs — remove duplicates
Components exist, but docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs contains duplicate nav entries: LumexAlert (2), LumexBadge (2), LumexCode (2), LumexDataGrid (2), LumexKbd (2), LumexRadioGroup (2); LumexDropdownTrigger and LumexRadio appear once. Remove the duplicated Add(new(nameof(...))) calls or dedupe when building the nav (inspect lines ~57, 61, 70, 73, 80, 83, 98, 99).
🤖 Prompt for AI Agents
In docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs around lines
57, 61, 70, 73, 80, 83, 98–99, the navigation list contains duplicated
Add(new(nameof(...))) entries (LumexAlert, LumexBadge, LumexCode, LumexDataGrid,
LumexKbd, LumexRadioGroup); remove the duplicate Add(...) calls so each
component is added only once or implement a simple dedupe step when building the
nav (e.g., use a HashSet of names before adding or filter the list for distinct
names) to ensure LumexDropdownTrigger and LumexRadio remain single entries and
no duplicates persist.
desmondinho
left a comment
desmondinho
left a comment
There was a problem hiding this comment.
I think Tooltip is missing
desmondinho
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1)
53-110: Optional guardrail: make nav additions idempotentTo prevent future duplicate entries creeping back in, make NavigationCategory.Add skip if Name already present (HashSet or DistinctBy on Name when finalizing the list).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs(4 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (4)
src/LumexUI/Components/Code/LumexCode.razor.cs (2)
LumexCode(17-84)LumexCode(53-56)src/LumexUI/Components/DataGrid/LumexDataGrid.razor.cs (1)
LumexDataGrid(220-244)src/LumexUI/Components/Dropdown/LumexDropdown.razor.cs (2)
LumexDropdown(15-44)LumexDropdown(24-29)src/LumexUI/Components/Kbd/LumexKbd.razor.cs (2)
LumexKbd(17-67)LumexKbd(39-42)
🔇 Additional comments (1)
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1)
57-57: Approve: Added missing Components API links — verification passedNo duplicate nameof(...) entries found; matching component classes exist under src/LumexUI/Components.
|
Thank you very much for your contribution! <3 P.S. Sorry, I just realized I forgot to thank you.. |
2 participants
Description
Adds missing documentation API links
What's been done?
Checklist
Additional Notes
No additional notes.
Summary by CodeRabbit