docs: make Pro route entry points explicit#2867
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
WalkthroughAdded a canonical Pro landing page and route-map callouts; replaced mixed OSS/Pro links in top-level docs with a single Pro route map entry; added route-map callouts on Pro feature pages and a new Fragment Caching Pro doc. Documentation-only changes; no code or public API modifications. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
Greptile SummaryThis is a documentation-only PR that establishes Confidence Score: 4/5Safe to merge after fixing the inverted "Compare OSS and Pro" row in the route map table. All six changed files are documentation only, all links resolve to existing files, and the structural intent is clear and correct. The single concrete issue — the "Start here"/"Then read" columns being reversed for the comparison row — is a one-line fix and would mislead readers who land on the route map looking to evaluate Pro. docs/pro/home-pro.md — route map table row 1 needs the Start here / Then read columns swapped Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[docs/README.md\nPro features section] -->|Start at| B[docs/pro/home-pro.md\nCanonical Route Map]
C[docs/oss/getting-started/quick-start.md\nGo Pro section] -->|Start at| B
B -->|Compare OSS & Pro| D[upgrading-to-pro.md]
B -->|Node.js SSR| E[node-renderer.md]
B -->|Progressive SSR| F[streaming-ssr.md]
B -->|Cache output| G[fragment-caching.md]
B -->|RSC| H[react-server-components/tutorial.md]
E -.->|Route map callout back| B
F -.->|Route map callout back| B
G -.->|Route map callout back| B
Reviews (1): Last reviewed commit: "docs: make Pro route entry points explic..." | Re-trigger Greptile |
Review: docs/pro navigation refactorOverall this is a clean, well-structured improvement. All linked files exist and the navigation intent is clear. Two issues worth addressing: 1. Route map columns swapped for "Compare OSS and Pro" row (inline comment on The "Start here" entry for the comparison row points to 2. Streaming SSR route map callout links to RSC tutorial (inline comment on Streaming SSR and RSC are independent features — you can use streaming SSR without RSC. Suggesting the RSC tutorial as a related path may send readers down the wrong fork. The Minor observation The old |
2c0f134 to
53ef074
Compare
Review: docs: make Pro route entry points explicitGood overall direction — having a canonical Pro landing page with a route map is a clear improvement over the previous scattered links. All file paths resolve correctly and the prose is clean. A few things worth addressing before merge: Must-fix
Worth considering
|
- Swap "Compare OSS and Pro" columns so readers start at the feature comparison page before the upgrade guide - Point streaming SSR route map to the technical streaming guide instead of the unrelated RSC tutorial Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Review: docs: make Pro route entry points explicitClean, well-scoped change. All file paths resolve correctly and the structural intent is clear. Two small fixes before merge: Must-fix
Clarification on previous bot feedback Intentional change confirmed? |
- Hyperlink "SSR caching guide" and "Pro configuration docs" in the fragment-caching.md route map blockquote - Remove redundant React on Rails Pro bullet in quick-start.md that duplicated the tip block link two lines above Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/oss/getting-started/quick-start.md (1)
193-193: Prefer a single Pro entry link here to avoid duplicated route maintenance.This line re-lists feature destinations that are already maintained in
docs/pro/home-pro.md. To keep one canonical navigation source, keep this tip focused on the Pro route map (and optionally just the upgrade guide), instead of linking every feature again.✂️ Suggested simplification
-Start at [React on Rails Pro](../../pro/home-pro.md) for the canonical route map. From there you can jump to the [upgrade guide](../../pro/upgrading-to-pro.md), [React Server Components](../../pro/react-server-components/tutorial.md), [streaming SSR](../../pro/streaming-ssr.md), [fragment caching](../../pro/fragment-caching.md), and the [Node renderer](../../pro/node-renderer.md). Free to evaluate — no license needed for development. +Start at [React on Rails Pro](../../pro/home-pro.md) for the canonical route map, then continue to the [upgrade guide](../../pro/upgrading-to-pro.md). Free to evaluate — no license needed for development.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/oss/getting-started/quick-start.md` at line 193, Replace the long list of Pro feature links in the sentence that starts with "Start at [React on Rails Pro]" with a single canonical Pro entry link (keep the "[React on Rails Pro]" link) and optionally retain only the upgrade guide link; remove the duplicate links to "[React Server Components]", "[streaming SSR]", "[fragment caching]", and "[Node renderer]" so the tip points users to the single Pro route map (and optionally the upgrade guide) instead of repeating each feature destination.
🤖 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/oss/getting-started/quick-start.md`:
- Line 193: Replace the long list of Pro feature links in the sentence that
starts with "Start at [React on Rails Pro]" with a single canonical Pro entry
link (keep the "[React on Rails Pro]" link) and optionally retain only the
upgrade guide link; remove the duplicate links to "[React Server Components]",
"[streaming SSR]", "[fragment caching]", and "[Node renderer]" so the tip points
users to the single Pro route map (and optionally the upgrade guide) instead of
repeating each feature destination.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: beb6f37f-cad1-487f-85bc-57151d5211a8
📒 Files selected for processing (2)
docs/oss/getting-started/quick-start.mddocs/pro/fragment-caching.md
✅ Files skipped from review due to trivial changes (1)
- docs/pro/fragment-caching.md
|
Overall, this is a well-structured documentation improvement. All internal links are valid, the route map table is a genuinely useful navigation aid, and Fragment Caching is correctly elevated to a first-class entry in the main README. A few items worth addressing: 1. Blockquote style vs. Docusaurus admonitions The three route-map callouts in 2. RSC page is missing the route-map callout Three of the four Pro feature entry-point pages get the new callout, but 3. Quick-start tip loses the key performance claim The previous tip included "10-100x faster SSR" as a quantified selling point. The replacement drops that claim. Consider preserving it alongside the route-map pointer. 4. Route map "Then read" for RSC points to a migration guide The RSC row links to |
Establish home-pro.md as the canonical Pro landing page with a route map table, and add breadcrumb blockquotes on individual Pro feature pages pointing back to it. - Add "Route Map" table to home-pro.md mapping reader needs to "Start here" and "Then read" links across 5 Pro feature families - Rewrite docs/README.md Pro section to funnel through home-pro.md - Add Fragment Caching to the Pro features list (was missing) - Add route map blockquotes to node-renderer.md, streaming-ssr.md, and fragment-caching.md with hyperlinked follow-on references - Update quick-start.md Pro tip to point to home-pro.md as entry point - Remove redundant duplicate link in quick-start.md bullet list Co-Authored-By: Justin Gordon <[email protected]> Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
…ew-fixes * origin/main: Remove dependency on internal TanStack Router router.ssr flag (#2833) Revert "Eliminate double JSON.stringify in RSC payload embedding (#2835)" (#2878) Eliminate double JSON.stringify in RSC payload embedding (#2835) docs: align Pro references with canonical docs routes (#2866) docs: make Pro route entry points explicit (#2867) Bump fastify from 5.8.1 to 5.8.3 in the npm-security group across 1 directory (#2846) docs: add RoR-specific competitive landscape and template refs (#2869) Clarify streaming narrative in RSC docs (#2813) (#2814)
Closes #2855
Summary
docs/pro/home-pro.mdthe canonical Pro route mapVerification
/Users/justin/codex/react_on_rails/node_modules/.bin/prettier --check docs/README.md docs/pro/home-pro.md docs/pro/node-renderer.md docs/pro/streaming-ssr.md docs/pro/fragment-caching.md docs/oss/getting-started/quick-start.mdgit diff --checkNote
Low Risk
Low risk documentation-only changes that primarily adjust navigation and clarify which Pro docs are canonical entry points.
Overview
Makes
docs/pro/home-pro.mdthe canonical React on Rails Pro landing page by adding a route-map table that directs readers to the right Pro feature overview and its deeper technical docs.Updates the docs “front doors” (
docs/README.mdand OSSquick-start.md) to funnel Pro exploration through this route map, and adds "Route map" callouts to Pro overview pages (node-renderer,streaming-ssr,fragment-caching) to distinguish entry-point overviews from lower-level guides.Written by Cursor Bugbot for commit 2c0f134. This will update automatically on new commits. Configure here.
Summary by CodeRabbit