Conversation
- Parse root CHANGELOG.md via existing getSourceCodeFromPath (local + raw GitHub on Vercel) - Show five releases per page with Previous/Next and npm link per version - Add Changelog under First Steps in docs nav; GitHub edit link targets CHANGELOG.md
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughAdds a paginated changelog page and markdown renderer to the docs, updates changelog content, introduces changelog parsing/highlighting utilities, refactors docs syntax styling and color tokens, adjusts docs layout/TOC/edit-link behavior, and adds a vulnerability-fix workflow doc. Changes
Sequence DiagramsequenceDiagram
actor User
participant Browser as Browser
participant NextPage as Next.js Page
participant Parser as parseChangelogMarkdown
participant Renderer as ChangelogMarkdown Component
participant Markdown as react-markdown / remarkGfm
User->>Browser: Request /docs/first-steps/changelog?page=1
Browser->>NextPage: Load page (server/client)
NextPage->>NextPage: getSourceCodeFromPath("CHANGELOG.md")
NextPage->>Parser: parseChangelogMarkdown(rawMarkdown)
Parser-->>NextPage: ChangelogRelease[] (versions + bodies)
NextPage->>NextPage: compute pagination slice & metadata
NextPage->>Renderer: render releases for current page
Renderer->>Markdown: render(markdown fragment)
Markdown-->>Renderer: parsed AST (headings, lists, code)
Renderer->>Browser: final HTML/JSX for page
Browser->>User: display paginated changelog
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly Related PRs
Suggested Reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
agents/security/fix-vulnerabilities.md (1)
15-15: Clarify validation scope for dependency-only integration branches.This line mandates build/lint/test for all relevant workspaces; for this repo’s dependency/security-only flow, consider explicitly allowing omission of non-required checks (e.g., lint/Chromatic) to avoid unnecessary CI churn.
Based on learnings: In the
rad-ui/uirepository, thesecurity-fixesbranch only updates dependencies, so linting and Chromatic workflows are not required for this branch.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@agents/security/fix-vulnerabilities.md` at line 15, The verification step "Verify: Run the project’s install, build, lint, and test commands (whatever this repo documents in package.json scripts / CI) until they pass for all relevant workspaces." is too strict for dependency/security-only branches; update this line to allow skipping non-required checks for such branches by adding an exception: specify that for dependency/security-only integration branches (e.g., branch names matching "security-*" or "dependabot/*") only install and the minimal build/test steps required by package.json must be run, and that linting and Chromatic may be omitted unless the PR changes code; also add a short note with the detection heuristic (branch name or a manifest of changed files) so CI maintainers can enforce the relaxed validation.docs/app/layout.js (1)
112-112: Scope hydration warning suppression more narrowly.Using
suppressHydrationWarningon both root tags can mask unrelated hydration bugs across the docs app. Prefer keeping it only on the element that is known to mismatch.Suggested adjustment
- <body className="h-screen overflow-hidden" suppressHydrationWarning> + <body className="h-screen overflow-hidden">Also applies to: 150-150
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/app/layout.js` at line 112, Remove suppressHydrationWarning from the root <html> tag in docs/app/layout.js and instead apply it only to the specific element that actually mismatches during hydration (e.g., the body or the smaller component that renders dynamic content); locate the two occurrences of suppressHydrationWarning on the <html> tag (the one shown with className={`${manrope.variable} ${jetbrainsMono.variable}`} and the other occurrence noted in the comment) and move the attribute to the narrower element that triggers the mismatch so the global <html> tag no longer suppresses unrelated hydration warnings.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@agents/security/fix-vulnerabilities.md`:
- Line 25: Fix the typos and clarity in the final summary instruction sentence:
change "relevan" to "relevant", "arent" to "aren't" (or "are not"), and reword
the sentence in agents/security/fix-vulnerabilities.md so it reads clearly — for
example: "Once all the relevant changes are done, provide a summary telling the
user which PRs can be closed, which are pending, and which were not addressed,
including relevant details and any blockers." Update the existing sentence in
the file to this corrected phrasing.
In `@docs/components/docsHelpers/EditPageOnGithub.tsx`:
- Around line 6-7: The default CHANGELOG edit constant CHANGELOG_EDIT_HREF
points to "rad-ui/ui" but other docs edit links are built for "rad-ui/rad-ui",
causing broken links; update the default edit URL used in EditPageOnGithub
(reference CHANGELOG_EDIT_HREF and the function that builds per-page edit links)
so both use the same repository ("rad-ui/ui") or make the per-page builder use
the CHANGELOG_EDIT_HREF base so all edit links consistently target "rad-ui/ui".
In `@docs/utils/changelog/parseChangelog.ts`:
- Around line 13-25: The parser currently turns any preamble text before the
first "##" into a synthetic "unknown" release; update the logic in
parseChangelog.ts to only produce entries for actual release headings by
filtering the chunks (the array produced by
withoutTitle.split(...).map(...).filter(Boolean)) to keep only items whose
headerLine matches /^##\s+(.+)$/ before mapping to { version, body } — i.e.,
detect the header via the same regex used in headerLine.match(...) and drop
non-matching chunks so no "unknown" version is emitted.
---
Nitpick comments:
In `@agents/security/fix-vulnerabilities.md`:
- Line 15: The verification step "Verify: Run the project’s install, build,
lint, and test commands (whatever this repo documents in package.json scripts /
CI) until they pass for all relevant workspaces." is too strict for
dependency/security-only branches; update this line to allow skipping
non-required checks for such branches by adding an exception: specify that for
dependency/security-only integration branches (e.g., branch names matching
"security-*" or "dependabot/*") only install and the minimal build/test steps
required by package.json must be run, and that linting and Chromatic may be
omitted unless the PR changes code; also add a short note with the detection
heuristic (branch name or a manifest of changed files) so CI maintainers can
enforce the relaxed validation.
In `@docs/app/layout.js`:
- Line 112: Remove suppressHydrationWarning from the root <html> tag in
docs/app/layout.js and instead apply it only to the specific element that
actually mismatches during hydration (e.g., the body or the smaller component
that renders dynamic content); locate the two occurrences of
suppressHydrationWarning on the <html> tag (the one shown with
className={`${manrope.variable} ${jetbrainsMono.variable}`} and the other
occurrence noted in the comment) and move the attribute to the narrower element
that triggers the mismatch so the global <html> tag no longer suppresses
unrelated hydration warnings.
🪄 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
Run ID: cb78086c-def5-4c0c-9971-ec8efe6bc88a
⛔ Files ignored due to path filters (1)
docs/pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (17)
CHANGELOG.mdagents/documentation/building-ui.mdagents/security/fix-vulnerabilities.mddocs/app/docs/docsNavigationSections.tsxdocs/app/docs/first-steps/changelog/ChangelogMarkdown.tsxdocs/app/docs/first-steps/changelog/highlightChangelogCode.tsxdocs/app/docs/first-steps/changelog/page.tsxdocs/app/docs/layout.tsxdocs/app/globals.scssdocs/app/layout.jsdocs/components/docsHelpers/EditPageOnGithub.tsxdocs/components/layout/Documentation/DocsTableOfContents.tsxdocs/components/layout/Documentation/helpers/CodeBlock.jsdocs/components/layout/Documentation/utils.jsdocs/components/navigation/NavItem.jsdocs/package.jsondocs/utils/changelog/parseChangelog.ts
💤 Files with no reviewable changes (1)
- docs/app/docs/layout.tsx
👮 Files not reviewed due to content moderation or server errors (6)
- docs/app/docs/first-steps/changelog/highlightChangelogCode.tsx
- docs/app/globals.scss
- docs/components/layout/Documentation/helpers/CodeBlock.js
- docs/app/docs/first-steps/changelog/page.tsx
- docs/app/docs/first-steps/changelog/ChangelogMarkdown.tsx
- CHANGELOG.md
… copy - Use shared rad-ui/ui edit base for changelog and MDX edit links - Drop changelog preamble chunks without a ## release heading (no unknown version) - Fix wording in fix-vulnerabilities agent summary instruction
Contributor
CoverageThis report compares the PR with the base branch. "Δ" shows how the PR affects each metric.
Coverage improved or stayed the same. Great job! Run |
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.
Summary by CodeRabbit
New Features
Documentation
Style
Chores