fix 404 sources link and add missing sources links #78
Conversation
|
@ameybh is attempting to deploy a commit to the Retro UI Team on Vercel. A member of the Team first needs to authorize it. |
|
Warning Rate limit exceeded@ameybh has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 8 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (3)
WalkthroughDocumentation MDX files were updated to add or correct front-matter Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
content/docs/components/avatar.mdx (1)
45-46: Fix typos in the “Fallbacks” section“helpfull” → “helpful”; “there ia” → “there is”. This is user-facing documentation.
Apply this diff:
-Fallbacks are helpfull when there ia an error loading the src of the avatar. +Fallbacks are helpful when there is an error loading the src of the avatar.content/docs/charts/pie-chart.mdx (1)
95-97: Default value mismatch: outerRadius documented as 80 but component default is 100.PieChart.tsx sets
outerRadius = 100by default; the doc lists80. Update the docs (or the component default) to stay consistent and avoid confusing users.Apply:
- <Table.Cell className="*:text-xs">`80`</Table.Cell> + <Table.Cell className="*:text-xs">`100`</Table.Cell>
♻️ Duplicate comments (4)
content/docs/components/input.mdx (1)
5-6: Source link added correctly; consistent with the pattern used elsewhere.The URL maps to components/retroui/Input.tsx as expected. Nothing else to change here.
Verification covered by the script in content/docs/components/text.mdx.
content/docs/components/alert.mdx (1)
5-6: Good addition; Alert.tsx source link follows the same convention.Looks consistent with the Contentlayer Links shape and other component docs.
Use the previously provided verification script to confirm no 404s.
content/docs/components/tab.mdx (1)
5-6: Tabs source link LGTM.Points to components/retroui/Tab.tsx and matches the front matter schema.
The link check script in the Text docs comment will validate this as well.
content/docs/utils/cn.mdx (1)
5-6: Utility source link added correctly.The link targets lib/utils.ts and fits the Links schema; consistent with component pages.
Covered by the verification script shared in content/docs/components/text.mdx.
🧹 Nitpick comments (7)
content/docs/components/textarea.mdx (1)
5-6: ✅ Source link verification passed (HTTP 200)
- The URL
https://github.com/Logging-Stuff/RetroUI/blob/main/components/retroui/Textarea.tsxresolves successfully and returns HTTP 200.- Great addition including the
sourcelink in the front matter—this aligns perfectly with our Contentlayer Links schema and will render in the docs UI as intended.Nit (optional): To guard against future link rot if the file moves or is renamed, consider using a commit-specific permalink (e.g.,
https://github.com/Logging-Stuff/RetroUI/blob/<commit-hash>/components/retroui/Textarea.tsx) instead of the branch-based URL.content/docs/components/text.mdx (1)
5-6: Optional: Consider pinning to a commit for long-term stability.Linking to main is fine today; pinning to a specific commit (or a release tag) prevents link rot if files are moved/renamed in the future. Only do this if you value immutability over always-current source.
content/docs/components/sonner.mdx (1)
37-37: Normalize self-closing break tag for consistencyThis page mixes
<br />and<br/>. Consider normalizing to<br />as used elsewhere in the docs.Apply this small tweak:
- <br/> + <br />content/docs/components/breadcrumb.mdx (1)
66-66: Minor spacing nitThere’s an extra
<br />right before EOF. If spacing isn’t intentional, consider removing to keep vertical rhythm consistent.-<br /> +<!-- intentional spacing retained or remove if not needed -->content/docs/charts/area-chart.mdx (1)
31-31: Nit: inconsistent indentation on closing Manual tag.Minor reading diff only. Consider aligning indentation with its opening tag for consistency across pages.
- </ComponentInstall.Manual> +</ComponentInstall.Manual>content/docs/components/loader.mdx (2)
97-137: Props list formatting is awkward (“- -prop”).The double-dash structure renders oddly. Simplify to a single bullet per prop with a nested list.
- - `variant` - - * Type: `default` | `secondary` | `outline` - * Default: `default` - * Description: Defines the style variant for the component +- `variant` + - Type: `default` | `secondary` | `outline` + - Default: `default` + - Description: Defines the style variant for the component @@ - - `size` - - * Type: `sm` | `md` | `lg` - * Default: `md` - * Description: Controls the size of the loader squares +- `size` + - Type: `sm` | `md` | `lg` + - Default: `md` + - Description: Controls the size of the loader squares @@ - - `count` - - * Type: `number` - * Default: `3` - * Description: Sets the number of bouncing squares +- `count` + - Type: `number` + - Default: `3` + - Description: Sets the number of bouncing squares @@ - - `duration` - - * Type: `number` - * Default: `0.5` - * Description: Controls the animation duration in seconds +- `duration` + - Type: `number` + - Default: `0.5` + - Description: Controls the animation duration in seconds @@ - - `delayStep` - - * Type: `number` - * Default: `100` - * Description: Defines the delay between squares in milliseconds +- `delayStep` + - Type: `number` + - Default: `100` + - Description: Defines the delay between squares in milliseconds @@ - - `className` - - * Type: `string` - * Default: `undefined` - * Description: Allows for adding additional CSS classes for custom styling +- `className` + - Type: `string` + - Default: `undefined` + - Description: Allows adding additional CSS classes for custom styling @@ - - `asChild` - * Type: `boolean` - * Default: `false` - * Description: When `true`, merges the component's props onto its immediate child element +- `asChild` + - Type: `boolean` + - Default: `false` + - Description: When `true`, merges the component's props onto its immediate child element
140-145: Accessibility note is solid; consider explicitly noting live region behavior (optional).Role="status" implies polite live region; adding that note can help readers understand SR behavior without changing code.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (25)
content/docs/charts/area-chart.mdx(2 hunks)content/docs/charts/bar-chart.mdx(2 hunks)content/docs/charts/line-chart.mdx(2 hunks)content/docs/charts/pie-chart.mdx(2 hunks)content/docs/components/accordion.mdx(1 hunks)content/docs/components/alert.mdx(1 hunks)content/docs/components/avatar.mdx(1 hunks)content/docs/components/badge.mdx(1 hunks)content/docs/components/breadcrumb.mdx(3 hunks)content/docs/components/button.mdx(1 hunks)content/docs/components/card.mdx(2 hunks)content/docs/components/dialog.mdx(1 hunks)content/docs/components/input.mdx(1 hunks)content/docs/components/label.mdx(2 hunks)content/docs/components/loader.mdx(3 hunks)content/docs/components/menu.mdx(1 hunks)content/docs/components/popover.mdx(1 hunks)content/docs/components/sonner.mdx(1 hunks)content/docs/components/switch.mdx(1 hunks)content/docs/components/tab.mdx(1 hunks)content/docs/components/text.mdx(1 hunks)content/docs/components/textarea.mdx(1 hunks)content/docs/components/toggle-group.mdx(1 hunks)content/docs/components/toggle.mdx(1 hunks)content/docs/utils/cn.mdx(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (23)
content/docs/components/input.mdx (3)
preview/components/input-style-default.tsx (1)
InputStyleDefault(3-5)components/retroui/Input.tsx (2)
props(7-25)InputProps(3-5)contentlayer.config.ts (1)
node(88-161)
content/docs/components/alert.mdx (2)
components/retroui/Alert.tsx (5)
IAlertDescriptionProps(44-45)IAlertProps(25-27)props(46-48)props(29-35)IAlertTitleProps(38-38)components/MDX.tsx (1)
props(53-77)
content/docs/components/switch.mdx (3)
preview/components/switch-style-default.tsx (1)
SwitchStyleDefault(4-11)components/retroui/Switch.tsx (1)
props(8-22)preview/components/switch-style-disabled.tsx (1)
SwitchStyleDisabled(4-10)
content/docs/components/toggle.mdx (4)
preview/components/toggle-style-outline-muted.tsx (1)
ToggleStyleOutlineMuted(4-10)preview/components/toggle-style-default.tsx (1)
ToggleStyleDefault(4-10)preview/components/toggle-style-solid.tsx (1)
ToggleStyleSolid(4-10)preview/components/toggle-style-outlined.tsx (1)
ToggleStyleOutlined(4-10)
content/docs/components/sonner.mdx (2)
components/retroui/Sonner.tsx (1)
props(7-29)contentlayer.config.ts (1)
node(88-161)
content/docs/components/badge.mdx (2)
components/retroui/Badge.tsx (2)
Badge(29-44)ButtonProps(25-27)contentlayer.config.ts (1)
name(16-24)
content/docs/components/popover.mdx (3)
components/retroui/Popover.tsx (1)
props(23-37)contentlayer.config.ts (1)
name(16-24)preview/components/popover-style-default.tsx (1)
PopoverStyleDefault(5-45)
content/docs/components/textarea.mdx (2)
contentlayer.config.ts (2)
name(16-24)tree(87-162)components/retroui/Textarea.tsx (1)
Textarea(4-21)
content/docs/components/text.mdx (2)
contentlayer.config.ts (1)
name(16-24)components/retroui/Text.tsx (2)
TextProps(24-28)props(30-37)
content/docs/components/menu.mdx (2)
components/retroui/Menu.tsx (3)
IMenuContent(10-11)props(13-25)props(30-39)preview/components/menu-style-default.tsx (1)
MenuDefault(4-17)
content/docs/charts/bar-chart.mdx (2)
components/retroui/charts/BarChart.tsx (2)
BarChartProps(15-29)value(32-157)preview/charts/bar-chart-style-horizontal.tsx (1)
BarChartStyleHorizontal(11-22)
content/docs/charts/line-chart.mdx (4)
preview/charts/line-chart-style-curved.tsx (1)
LineChartStyleCurved(13-25)preview/charts/line-chart-style-dots.tsx (1)
LineChartStyleDots(12-25)preview/charts/line-chart-style-default.tsx (1)
LineChartStyleDefault(5-13)components/retroui/charts/LineChart.tsx (2)
value(32-130)LineChartProps(15-29)
content/docs/components/label.mdx (2)
preview/components/label.tsx (1)
LabelDefault(6-13)components/retroui/Label.tsx (1)
props(11-16)
content/docs/components/tab.mdx (3)
preview/components/tab-style-default.tsx (1)
TabStyleDefault(3-21)components/retroui/Tab.tsx (5)
ITabsContent(48-50)props(34-46)ITabsTrigger(31-33)props(51-60)props(19-29)contentlayer.config.ts (1)
name(16-24)
content/docs/components/toggle-group.mdx (1)
components/retroui/ToggleGroup.tsx (2)
props(39-57)props(21-31)
content/docs/components/avatar.mdx (1)
components/retroui/Avatar.tsx (3)
props(9-18)props(24-30)props(36-45)
content/docs/charts/area-chart.mdx (1)
components/retroui/charts/AreaChart.tsx (2)
AreaChartProps(15-29)value(32-151)
content/docs/components/accordion.mdx (4)
preview/components/accordion-style-default.tsx (1)
AccordionStyleDefault(5-28)components/retroui/Accordion.tsx (3)
props(14-23)props(49-57)props(29-43)config/components.ts (1)
() => import("@/preview/components/accordion-style-default")(146-146)contentlayer.config.ts (1)
tree(87-162)
content/docs/components/button.mdx (5)
components/retroui/Button.tsx (2)
props(40-61)IButtonProps(33-37)preview/components/button-style-link.tsx (1)
ButtonStyleLink(3-5)preview/components/button-style-outline.tsx (1)
ButtonStyleOutline(3-5)preview/components/button-style-icon.tsx (1)
ButtonStyleIcon(4-10)preview/components/button-style-secondary.tsx (1)
ButtonStyleSecondary(3-5)
content/docs/charts/pie-chart.mdx (1)
components/retroui/charts/PieChart.tsx (3)
PieChartProps(13-25)value(28-100)active(70-93)
content/docs/components/breadcrumb.mdx (5)
preview/components/breadcrumb-custom-separator.tsx (1)
BreadcrumbCustomSeparator(4-26)preview/components/breadcrumb-style-collapsed.tsx (1)
BreadcrumbCollapsed(5-30)preview/components/breadcrumb-style-default.tsx (1)
BreadcrumbStyleDefault(3-21)components/retroui/Breadcrumb.tsx (5)
props(45-57)props(89-101)props(73-86)props(37-39)props(63-70)preview/components/breadcrumb-link-component.tsx (1)
BreadcrumbLinkComponent(5-27)
content/docs/components/loader.mdx (1)
components/retroui/Loader.tsx (2)
props(35-68)LoaderProps(25-32)
content/docs/components/card.mdx (2)
preview/components/card-style-default.tsx (1)
BasicCard(3-15)components/ComponentInstall.tsx (2)
ComponentInstall(115-130)command(10-30)
🪛 LanguageTool
content/docs/components/loader.mdx
[grammar] ~99-~99: There might be a mistake here.
Context: ...t * Type:default|secondary|outline * Default:default` * Description: Defi...
(QB_NEW_EN)
[grammar] ~100-~100: There might be a mistake here.
Context: ... | secondary | outline * Default: default * Description: Defines the style variant f...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ...nt - - size * Type: sm | md | lg * Default: md * Description: Controls ...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...* Type: sm | md | lg * Default: md * Description: Controls the size of the lo...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ... loader squares - - count * Type: number * Default: 3 * Description: Sets the n...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...count * Type:number * Default:3` * Description: Sets the number of bouncing...
(QB_NEW_EN)
[grammar] ~117-~117: There might be a mistake here.
Context: ...cing squares - - duration * Type: number * Default: 0.5 * Description: Controls...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...ation * Type:number * Default:0.5` * Description: Controls the animation dura...
(QB_NEW_EN)
[grammar] ~123-~123: There might be a mistake here.
Context: ... in seconds - - delayStep * Type: number * Default: 100 * Description: Defines ...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...yStep * Type:number * Default:100` * Description: Defines the delay between s...
(QB_NEW_EN)
[grammar] ~129-~129: There might be a mistake here.
Context: ...illiseconds - - className * Type: string * Default: undefined * Description: Al...
(QB_NEW_EN)
[grammar] ~130-~130: There might be a mistake here.
Context: ...sName * Type:string * Default:undefined` * Description: Allows for adding additiona...
(QB_NEW_EN)
[grammar] ~134-~134: There might be a mistake here.
Context: ...custom styling - - asChild * Type: boolean * Default: false * Description: When `...
(QB_NEW_EN)
[grammar] ~135-~135: There might be a mistake here.
Context: ...Child * Type:boolean * Default:false * Description: Whentrue`, merges the com...
(QB_NEW_EN)
content/docs/components/card.mdx
[grammar] ~22-~22: There might be a mistake here.
Context: ...s and templates! RetroUI Pro  RetroUI Docs Components Blog Star on GitHub  G...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ... templates! RetroUI Pro  RetroUI Docs Components Blog Star on GitHub  Gettin...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ... RetroUI Pro  RetroUI Docs Components Blog Star on GitHub  Getting Started I...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...troUI Pro  RetroUI Docs Components Blog Star on GitHub  Getting Started Introductio...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...s Blog Star on GitHub  Getting Started Introduction Installation Blocks Pro Tem...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...on GitHub  Getting Started Introduction Installation Blocks Pro Templates Pro Fi...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...etting Started Introduction Installation Blocks Pro Templates Pro Figma Kit Pro C...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...Started Introduction Installation Blocks Pro Templates Pro Figma Kit Pro Componen...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...ted Introduction Installation Blocks Pro Templates Pro Figma Kit Pro Components A...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...uction Installation Blocks Pro Templates Pro Figma Kit Pro Components Accordion ...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...on Installation Blocks Pro Templates Pro Figma Kit Pro Components Accordion ####...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...ation Blocks Pro Templates Pro Figma Kit Pro Components Accordion #### Copy the ...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...n Blocks Pro Templates Pro Figma Kit Pro Components Accordion #### Copy the code...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...o Templates Pro Figma Kit Pro Components Accordion #### Copy the code 👇 into yo...
(QB_NEW_EN)
🔇 Additional comments (26)
content/docs/components/dialog.mdx (1)
7-7: Allsource:links have been successfully verified (HTTP 200)
No broken links remain in the updated docs. Optionally, consider using GitHub permalinks for stronger long-term stability.content/docs/components/badge.mdx (1)
5-6: Nice: added missing source linkMatches the Badge.tsx location and contentlayer front matter shape. No further changes needed.
If desired, extend with an api_reference in the same links block for external deps (optional).
content/docs/components/toggle.mdx (1)
5-6: Consistent source linking addedThe Toggle.tsx reference follows the PR’s pattern and should fix any missing “View source” affordance in the docs.
If you want to future-proof, consider a commit permalink instead of blob/main.
content/docs/components/toggle-group.mdx (1)
5-6: Source link wired upPoints to components/retroui/ToggleGroup.tsx as expected. Looks good.
Optional: add links.api_reference to Radix Toggle Group docs for parity with other pages (e.g., Dialog).
content/docs/components/text.mdx (1)
5-6: ✅ Alllinks.sourceURLs and paths verified
- Every
links.sourceURL returns HTTP 200- All corresponding local GitHub blob paths exist
LGTM!
content/docs/components/menu.mdx (1)
7-7: Good fix: source link now points to the correct Menu.tsx pathThe updated link resolves the 404 by targeting components/retroui/Menu.tsx on main. Looks consistent with the component’s actual location.
content/docs/components/avatar.mdx (1)
5-6: Nice addition: added missing source link for Avatar.tsxFront matter now includes a stable link to the component source. Matches the repo path and casing.
content/docs/components/switch.mdx (1)
7-7: Path casing corrected for Switch.tsxThe link now matches the file name casing (Switch.tsx). This should eliminate case-related 404s on GitHub.
content/docs/components/label.mdx (1)
5-6: Good addition: source link for Label.tsxFront matter now points to the correct component source. Matches repository casing.
content/docs/components/accordion.mdx (1)
7-7: Corrected source path for Accordion.tsxUpdated from the old nested path to the actual Accordion.tsx location. Eliminates the broken link.
content/docs/components/sonner.mdx (1)
7-7: Verification Passed: Sonner.tsx Link is ValidThe
sourceURL was checked and returns HTTP 200, confirming it’s reachable. Documentation remains consistent and accurate—approving.content/docs/components/breadcrumb.mdx (2)
18-20: Code fence fix is correctClosing the shell code block with three backticks resolves the broken fence.
5-6: Link Validated for Breadcrumb Component
- In
content/docs/components/breadcrumb.mdx(lines 5–6), thelinks.sourceURL has been confirmed to return HTTP 200 and correctly points tocomponents/retroui/Breadcrumb.tsx. No further changes required.content/docs/charts/bar-chart.mdx (2)
29-29: Good switch to inline ComponentSource tagReplacing a header-styled embed with an inline tag avoids malformed heading structure and keeps the page semantics clean.
3-6: Bar chart front matter verification complete
- Source link resolves successfully (HTTP 200).
- Default prop values in
BarChart.tsxalign with documentation:
• strokeColors:["var(--foreground)"]
• fillColors:["var(--primary)"]
• tooltipBgColor:"var(--background)"
• tooltipBorderColor:"var(--border)"
• showGrid:true
• showTooltip:true
• alignment:"vertical"content/docs/charts/area-chart.mdx (3)
5-6: Good fix: added canonical source link in front matter.The new links.source points to the TSX implementation and should help prevent 404s going forward.
29-29: Inline ComponentSource usage is consistent with other docs.Switching from a “## <ComponentSource …>” heading to an inline tag reads cleaner and aligns with the pattern across chart docs.
5-6: links.source URLs currently valid—recommend adding CI checkAll
links.sourceURLs in the docs (including the one incontent/docs/charts/area-chart.mdx) were verified to return HTTP 200 status codes when fetched by the provided script.• File:
content/docs/charts/area-chart.mdx
– URL: https://github.com/Logging-Stuff/RetroUI/blob/main/components/retroui/charts/AreaChart.tsx → HTTP 200Recommend integrating the same shell script into your CI pipeline to automatically validate these URLs on each commit and catch any future regressions.
content/docs/charts/line-chart.mdx (3)
3-6: Docs metadata improved and linked to source.Updated description and added links.source to components/retroui/charts/LineChart.tsx — looks correct and matches the component path.
29-29: Inline ComponentSource tag matches PR intent.Consistent with other files; no functional changes.
5-6: Add link check in CI (same as other pages).See suggested script in Area Chart comment to validate this URL as part of CI to prevent future 404s.
content/docs/charts/pie-chart.mdx (2)
5-6: Good: added links.source to the component.The path matches components/retroui/charts/PieChart.tsx.
29-29: Inline ComponentSource tag change LGTM.content/docs/components/card.mdx (1)
5-6: Added links.source: good addition.Front matter now references the Card.tsx source; helps readers jump to implementation.
content/docs/components/loader.mdx (2)
5-6: Nice: added links.source to Loader.tsx.Direct link to the component source improves traceability.
78-83: Usage snippet reads well. Minor copy edit (optional).“Delay between squares in milliseconds” is clear; all prop names match the component. No action needed.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
2 participants
Summary by CodeRabbit