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 (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughAdded an unlisted Pro compatibility stub page 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
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
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 |
- 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 |
Code ReviewOverviewThis PR adds a URL-compatibility stub ( What works well
IssuesMinor — comment block miscategorises
|
…ages * origin/main: Fix initial page startup race for late-loading client bundles (#3151) chore: apply prettier formatting to tracked docs files (#3153) docs: comprehensive RSC API documentation and registration consolidation (#3140) Split rspec-package-tests into parallel generator/unit shards (#3134) fix: add concurrency groups to long-running CI workflows (#3133) refactor: add RenderRequest, JsCodeBuilder, and RenderingStrategy abstractions (#3094) fix: address deferred review items from PR #2849 (#3093) Add complimentary OSS license policy for React on Rails Pro (#3123) fix: centralize CI docs-only detection and add CLI flag validation (#3091) refactor: replace stub-throw + Object.assign with capability-based composition (#3096) Enhance address-review with parallel fixes, self-review, and Greptile verification (#3121) fix: Doctor no longer fails custom projects for missing bin/dev (#3117) fix: cap webpack <5.106.0 to prevent ExecJS SSR breakage (#3095) Add Rspack + RSC compatibility tests and documentation (#1828) (#3120) Add error scenarios hub and test pages (#2497) docs: document polyfill requirements for web-targeted server bundles (#3092) docs: RSC integration pitfalls from tutorial app (#3087) docs: fix render function/helper API documentation (#3088) Doctor: accept TS/TSX server bundle suffixes (#3111) feat: add CI guard requiring sidebar updates when adding docs (#3089)
Why: home-pro is an unlisted URL-compatibility stub redirecting to pro/react-on-rails-pro and is intentionally not in sidebars.ts. After merging main (which introduced .sidebar-exclusions), the new CI guard now correctly enforces that omission via this exclusion list. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Code ReviewSummary: Documentation-only PR that adds a URL-compatibility stub ( What Works Well
Minor IssuesComment placement inconsistency in The new comment line is placed under the block header "Intentionally excluded from sidebar (legacy stubs that redirect to archive)", but No full Docusaurus build validated The PR description notes: "I did not run a full Docusaurus build in this workspace." While all referenced doc IDs exist on disk, a full build would catch any broken AssessmentLow risk, clean change. The stub pattern is appropriate for URL compatibility, and the exclusion from sidebar/search is correctly implemented. The comment grouping fix in |
Why: pro/home-pro was incorrectly grouped under "legacy stubs that redirect to archive", but it points to a live page (pro/react-on-rails-pro) not an archive route. Future editors could misread the categorization. Addresses review feedback on #3119. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|
Thanks @claude[bot]. The inline-comment categorization issue (the only actionable item flagged) is addressed in d7ed940 — |
Review Round SummaryAddressed:
CI fixes (pushed alongside):
No further action needed on the bot review summaries (greptile 5/5, coderabbit "no actionable comments") — the only actionable inline issue from those summaries was the categorization fix above. I (Claude Code) made these changes. |
Code ReviewSummary: Clean, low-risk docs-only change. Adds a URL-compatibility stub for What's Good
Minor Observations
VerdictApprove after confirming either (a) a local Docusaurus build passes, or (b) CI runs the build successfully. The logical structure and file hygiene are solid. |
### 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-pro` into a compatibility page so the sidebar can be simplified without changing existing doc routes. ### Pull Request checklist - [x] ~Add/update test to cover these changes~ - [x] Update documentation - [x] ~Update CHANGELOG file~ ### Other Information Validated with `pnpm exec eslint docs/sidebars.ts`, `pnpm exec prettier --check` on the changed files, and a doc-id existence check covering 105 sidebar references. I did not run a full Docusaurus build in this workspace. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk documentation-only change; primary risk is broken navigation if the stub/exclusion IDs don’t match Docusaurus doc IDs. > > **Overview** > Adds an **unlisted URL-compatibility stub** at `docs/pro/home-pro.md` that keeps the legacy `pro/home-pro` route working and directs readers to the canonical `pro/react-on-rails-pro` page (with a small set of Pro quick links). > > Updates sidebar exclusion configuration (`docs/.sidebar-exclusions` and comments in `docs/sidebars.ts`) to explicitly exclude `pro/home-pro` from navigation so it functions purely as a compatibility entry point. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit d7ed940. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added an unlisted Pro home compatibility stub that links to the canonical Pro landing and includes a “Quick Links” section to Pro resources (installation, OSS→Pro upgrade, React Server Components, Streaming SSR, Node Renderer). * Excluded the stub from the site sidebar so it serves as a URL-compatibility redirect to the main Pro landing. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
…ging' into jg/3122-rolling-deploy-adapter * origin/jg/3122-unify-renderer-cache-staging: (39 commits) fix(specs): boot dummy specs without readline and drop redundant pnpm workspace (#3190) docs: add RSC migration success stories page (#1985) (#3162) Fix Bencher reporting permanently broken on pushes to main (#3148) docs: add example migrations guide (#3126) docs: remove defunct guavapass.com reference (#3199) chore: remove redundant --rsc-pro install generator flag (#3105) ci: warn (don't fail) on Bencher main regression (#3168) test: enable RSpec --profile to surface slowest package tests (#3176) fix(node-renderer): expose performance in VM context when supportModules (#3158) docs: remove stale immediate_hydration references (#3139) (#3159) docs: restore absolute URL for node-renderer testing example (#3179) Bump Rspack dependencies to v2 (^2.0.0-0) (#3084) chore: remove obsolete webpack <5.106.0 pin (#3175) Move Node Renderer entry point to renderer/ directory (#3165) docs: address RSC pitfalls review follow-ups (#3155) (#3156) docs: remove fabricated DevConsole reference, link verified RSC tools (#2527) (#3163) Scaffold CI workflow and build scripts for first-run consistency (#3097) Add OPTIONAL triage tier and fix recommendations to /address-review (#3161) chore: sync Gemfile.lock with term-ansicolor 1.11.3 (#3164) Simplify the docs sidebar and Pro landing pages (#3119) ...
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; primary risk is broken navigation if the stub/exclusion IDs don’t match Docusaurus doc IDs.
Overview
Adds an unlisted URL-compatibility stub at
docs/pro/home-pro.mdthat keeps the legacypro/home-proroute working and directs readers to the canonicalpro/react-on-rails-propage (with a small set of Pro quick links).Updates sidebar exclusion configuration (
docs/.sidebar-exclusionsand comments indocs/sidebars.ts) to explicitly excludepro/home-profrom navigation so it functions purely as a compatibility entry point.Reviewed by Cursor Bugbot for commit d7ed940. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit