Simplify the docs sidebar and Pro landing pages#3119
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
WalkthroughA new documentation compatibility stub page is added at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
…ages * origin/main: (44 commits) Consolidate CSP nonce sanitization into shared module (#2828) Add comprehensive --rsc-pro generator tests (#3098) fix: cross-env validation and docs for renderer password (#3090) Improve package metadata and Pro upgrade CTAs (#3112) docs: standardize warning syntax to GFM alert format (#3115) docs: improve react-intl documentation for React Server Components (#3085) Fix generator CI SSR regression on main (#3110) Refocus GitHub README on docs navigation (#3113) Add manual dev environment testing checklist for coding agents (#3074) Bump version to 16.6.0 Update CHANGELOG.md for 16.6.0 (#3078) fix: node-renderer diagnostic improvements (#3086) fix: pin third-party npm deps in generator to prevent peer dep conflicts (#3083) chore(deps): bump lodash from 4.17.23 to 4.18.1 in the npm-security group across 1 directory (#2920) fix: refactor formatExceptionMessage to accept generic request context (#2877) Bump version to 16.6.0.rc.1 Update CHANGELOG.md for 16.6.0.rc.1 (#3079) Update CHANGELOG.md unreleased section (#3077) Fix Content-Length mismatch and null renderingRequest errors in node renderer (#3069) Improve memory debugging docs with simpler heap snapshot approach (#3072) ... # Conflicts: # docs/pro/home-pro.md # docs/pro/react-on-rails-pro.md # docs/sidebars.ts
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/pro/react-on-rails-pro.md (1)
38-44: Clarify the dummy-app link target.The link text reads like a directory path, but it lands on the dummy app README. Renaming it to something like
dummy app READMEwould make the destination less surprising.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/pro/react-on-rails-pro.md` around lines 38 - 44, Update the link text that currently reads "react_on_rails_pro/spec/dummy" to a clearer label like "dummy app README" so the anchor matches its target README; locate the markdown line containing the link text "react_on_rails_pro/spec/dummy" in react-on-rails-pro.md and replace the visible text while keeping the existing URL unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/pro/react-on-rails-pro.md`:
- Around line 38-44: Update the link text that currently reads
"react_on_rails_pro/spec/dummy" to a clearer label like "dummy app README" so
the anchor matches its target README; locate the markdown line containing the
link text "react_on_rails_pro/spec/dummy" in react-on-rails-pro.md and replace
the visible text while keeping the existing URL unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1a38f3fa-d631-4a5b-bd52-34fd241737f1
📒 Files selected for processing (5)
docs/oss/upgrading/release-notes/index.mddocs/pro/home-pro.mddocs/pro/react-on-rails-pro.mddocs/pro/release-notes/index.mddocs/sidebars.ts
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Review: Simplify the docs sidebar and Pro landing pagesScope note: The PR title and description mention sidebar reorganisation (removing redundant top-level sections, nesting RSC under Pro, release-note archive pages), but the actual diff is a single 14-line file: The compatibility page itselfAll six relative links in the file resolve to existing files:
The file is intentionally absent from One actionable issueSee inline comment: Docusaurus v3 warns about docs that exist on disk but appear in no sidebar. Adding |
Greptile SummaryThis PR simplifies the docs sidebar by regrouping content under cleaner top-level categories, moves RSC under "React on Rails Pro", surfaces "Deployment" as its own section, and adds a "Upgrading & Migration" section that aggregates both OSS and Pro upgrade docs. It also introduces All sidebar doc IDs I could verify resolve to real files on disk ( Confidence Score: 5/5Safe to merge — documentation-only change with no runtime code impact. All P2-or-lower findings; previous frontmatter concern was resolved in a7a20bc; verified sidebar doc IDs map to real files; no broken links or logic issues identified. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Old /pro/home-pro URL"] -->|"unlisted: true stub"| B["docs/pro/home-pro.md"]
B -->|"redirect link"| C["docs/pro/react-on-rails-pro.md\n(canonical Pro landing)"]
D["Sidebar docsSidebar"] --> E["Getting Started"]
D --> F["Core Concepts"]
D --> G["Building Features"]
D --> H["Reference"]
D --> I["Deployment"]
D --> J["Upgrading & Migration"]
D --> K["React on Rails Pro"]
J --> L["upgrading/release-notes/index\n(OSS archive)"]
J --> M["pro/release-notes/index\n(Pro archive)"]
K --> N["pro/react-server-components/*\n(RSC — moved under Pro)"]
G --> O["building-features/node-renderer/*\n(Node Renderer Pro — detailed articles)"]
Reviews (2): Last reviewed commit: "Add unlisted frontmatter to home-pro com..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
- Add `unlisted: true` and `description` frontmatter to docs/pro/home-pro.md to suppress Docusaurus "not in any sidebar" build warning - Note pro/home-pro in sidebars.ts excluded-files comment for discoverability Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
|
Re the scope question from @claude[bot]: the sidebar reorganization in Re the P2 suggestion from @greptile-apps[bot] about noting |
| @@ -5,6 +5,7 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; | |||
| // - building-features/rails-webpacker-react-integration-options | |||
| // - deployment/troubleshooting-when-using-webpacker | |||
| // - misc/asset-pipeline | |||
There was a problem hiding this comment.
The pro/home-pro entry is grouped under the header comment "legacy stubs that redirect to archive", but home-pro is a compatibility stub pointing to the current Pro landing page (pro/react-on-rails-pro), not an archive. This creates a misleading categorisation.
Consider splitting the block into two sections, e.g.:
| // - misc/asset-pipeline | |
| // - pro/home-pro (URL-compatibility stub → pro/react-on-rails-pro) | |
| // | |
| // Intentionally excluded from sidebar (legacy stubs that redirect to archive): |
Or rename the header to cover both cases:
| // - misc/asset-pipeline | |
| // - pro/home-pro (URL-compatibility stub → pro/react-on-rails-pro) | |
| // | |
| // Contributing/Resources pages (linked from introduction.md instead of sidebar): |
Either way, the distinction between "points to a live page" and "points to an archive" is worth preserving for future editors.
Code ReviewOverviewThis PR adds a URL-compatibility stub ( What works well
IssuesMinor — comment block miscategorises
|
1 participant
Summary
Simplify the docs information architecture by removing redundant top-level sidebar sections, regrouping Building Features, keeping Deployment visible, and nesting React Server Components under React on Rails Pro. Add release note archive pages and turn
home-prointo a compatibility page so the sidebar can be simplified without changing existing doc routes.Pull Request checklist
Add/update test to cover these changesUpdate CHANGELOG fileOther Information
Validated with
pnpm exec eslint docs/sidebars.ts,pnpm exec prettier --checkon the changed files, and a doc-id existence check covering 105 sidebar references. I did not run a full Docusaurus build in this workspace.Note
Low Risk
Low risk documentation-only change that adds a stub page and updates a sidebar comment; no runtime code or behavior is affected beyond docs navigation/links.
Overview
Adds a new unlisted
docs/pro/home-pro.mdpage that acts as a compatibility landing page, pointing readers topro/react-on-rails-proand key Pro docs.Updates
docs/sidebars.tscomments to explicitly document thatpro/home-prois intentionally excluded from the sidebar as a URL-compatibility stub.Reviewed by Cursor Bugbot for commit a7a20bc. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit