Skip to content

docs: make Pro route entry points explicit#2867

Merged
ihabadham merged 3 commits intomainfrom
jg-codex/pro-routes
Mar 28, 2026
Merged

docs: make Pro route entry points explicit#2867
ihabadham merged 3 commits intomainfrom
jg-codex/pro-routes

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 26, 2026

Closes #2855

Summary

  • make docs/pro/home-pro.md the canonical Pro route map
  • point the docs front door and OSS quick start through that route map before jumping into feature-specific pages
  • clarify which Pro pages are entry-point overviews versus deeper technical docs

Verification

  • /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.md
  • git diff --check

Note

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.md the 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.md and OSS quick-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

  • Documentation
    • Reorganized Pro features into a canonical Pro landing page and route map for clearer discovery
    • Replaced individual Pro feature links in README with Pro-specific routes and adjusted link order/text
    • Added a Fragment Caching entry to Pro docs
    • Added route-map callouts across Pro guides (Node Renderer, Streaming SSR, Fragment Caching) to steer readers to the canonical entry and related deep dives
    • Updated Quick Start Pro tip to point to the Pro route map and describe a three-step OSS→Pro upgrade flow

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 26, 2026

Walkthrough

Added 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

Cohort / File(s) Summary
Docs root / OSS quick-start
docs/README.md, docs/oss/getting-started/quick-start.md
Replaced mixed OSS/Pro feature links with a single canonical Pro route-map entry and updated the “Go Pro / Upgrade” wording to point users to the Pro landing page and upgrade guide.
Pro landing page
docs/pro/home-pro.md
Added a canonical Pro landing page with a "Route Map" table mapping user needs to Pro start pages and follow-up technical docs.
Pro feature pages
docs/pro/fragment-caching.md, docs/pro/node-renderer.md, docs/pro/streaming-ssr.md
Inserted "Route map" blockquote/callouts linking to the Pro landing page and to relevant technical/deep-dive docs; added new fragment-caching route.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through pages, tidy and bright,
One map to Pro to guide the night.
Links aligned, fragments found their place,
A nimble trail for every case. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main objective: making Pro route entry points explicit through documentation updates.
Linked Issues check ✅ Passed All four acceptance criteria from issue #2855 are met: canonical Pro entry routes established, overview pages enhanced with route maps, cross-links updated, and navigation model clarified.
Out of Scope Changes check ✅ Passed All changes are within scope—documentation updates establishing canonical Pro routes and adding navigation clarity as specified in issue #2855.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg-codex/pro-routes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Mar 26, 2026

Greptile Summary

This is a documentation-only PR that establishes docs/pro/home-pro.md as the canonical Pro landing page and routes all entry points (the main docs README and the OSS quick-start guide) through it before reaching feature-specific pages. Each Pro feature page (streaming-ssr.md, node-renderer.md, fragment-caching.md) also gains a back-link callout so readers who land on a deep page know where the route map lives.\n\nKey changes:\n- docs/pro/home-pro.md: New introductory paragraph and a Route Map table listing five "Need → Start here → Then read" paths\n- docs/README.md: Pro features section now leads with a pointer to home-pro.md; Streaming SSR and Node Renderer links updated from OSS build-feature pages to their Pro overview counterparts; Fragment Caching and Upgrading to Pro entries added\n- docs/oss/getting-started/quick-start.md: Pro upgrade tip and bullet list both now route through home-pro.md first\n- docs/pro/{fragment-caching,node-renderer,streaming-ssr}.md: Consistent route-map callout added at the top of each page\n\nOne issue found: the "Compare OSS and Pro" row in the Route Map table has its Start here and Then read columns reversed — a reader evaluating whether to upgrade should start with the comparison page, not the upgrade guide.

Confidence Score: 4/5

Safe 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

Filename Overview
docs/pro/home-pro.md New route map table added; "Compare OSS and Pro" row has Start here / Then read columns in a counterintuitive order (upgrade guide before comparison page)
docs/README.md Pro features section updated to funnel through home-pro.md; all links resolve correctly; Fragment Caching and Upgrading to Pro added to the list
docs/oss/getting-started/quick-start.md Pro upgrade tip and bullet list updated to route through home-pro.md first; all links valid
docs/pro/fragment-caching.md Route map callout added at the top pointing back to home-pro.md; consistent with other Pro feature pages
docs/pro/node-renderer.md Route map callout added at the top pointing back to home-pro.md; consistent with other Pro feature pages
docs/pro/streaming-ssr.md Route map callout added at the top pointing back to home-pro.md; consistent with other Pro feature pages

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
Loading

Reviews (1): Last reviewed commit: "docs: make Pro route entry points explic..." | Re-trigger Greptile

Comment thread docs/pro/home-pro.md Outdated
Comment thread docs/pro/home-pro.md Outdated
Comment thread docs/pro/streaming-ssr.md Outdated
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 26, 2026

Review: docs/pro navigation refactor

Overall 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 home-pro.md:11)

The "Start here" entry for the comparison row points to upgrading-to-pro.md, which is the how-to-migrate guide. A reader who wants to compare features before deciding should start at oss-vs-pro.md. The columns are logically reversed for this row.

2. Streaming SSR route map callout links to RSC tutorial (inline comment on streaming-ssr.md:5)

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 streaming-server-rendering.md technical guide is a better "then read" target here.

Minor observation

The old docs/README.md Pro section included a direct link to Add RSC to Existing Pro App which has been removed. It's now only reachable via the route map table in home-pro.md. That's fine since home-pro.md is now the canonical entry point, but worth confirming this was intentional.

@ihabadham ihabadham force-pushed the jg-codex/pro-routes branch from 2c0f134 to 53ef074 Compare March 28, 2026 02:36
Comment thread docs/pro/home-pro.md Outdated
Comment thread docs/pro/fragment-caching.md Outdated
Comment thread docs/oss/getting-started/quick-start.md
Comment thread docs/README.md
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 28, 2026

Review: docs: make Pro route entry points explicit

Good 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

  • The 'Compare OSS and Pro' row in the home-pro.md route map has the columns swapped (see inline comment). Someone deciding whether to upgrade should start at the comparison page, not the upgrade guide.
  • fragment-caching.md mentions 'Pro configuration docs' as plain text but omits the hyperlink (see inline comment).

Worth considering

  • quick-start.md ends up with two links to home-pro.md within four lines — once in the tip block and once as a standalone bullet. The bullet is redundant.
  • The upgrading-existing-pro-app.md link was dropped from docs/README.md with no alternative route for users who are already on Pro and want to add RSC. The route map in home-pro.md only covers the RSC tutorial, not the dedicated existing-Pro upgrade path. Either restore the link or add a row to the route map for that case.

- 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]>
Comment thread docs/pro/fragment-caching.md Outdated
Comment thread docs/oss/getting-started/quick-start.md Outdated
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 28, 2026

Review: docs: make Pro route entry points explicit

Clean, well-scoped change. All file paths resolve correctly and the structural intent is clear. Two small fixes before merge:

Must-fix

  • fragment-caching.md:5 — The route map callout mentions "SSR caching guide" and "Pro configuration docs" as plain text with no hyperlinks. Both references exist in the repo and should be linked (see inline comment with suggestion).
  • quick-start.md:196 — A standalone bullet linking to home-pro.md appears two lines after the tip block that already links there. The bullet is redundant and can be removed (see inline comment).

Clarification on previous bot feedback
Several prior review comments (greptile, earlier claude reviews) flagged the "Compare OSS and Pro" row in the route map as having its columns swapped. Looking at the actual file, the order is correct: Start here → OSS vs Pro comparison, Then read → Upgrade to Pro. That is the right progression for someone evaluating a Pro purchase. Those comments can be dismissed.

Intentional change confirmed?
The direct link to Add RSC to Existing Pro App was removed from docs/README.md. That path is still reachable via the route map's RSC row (home-pro.md → "Then read" → upgrading-existing-pro-app.md), so this appears intentional and is fine.

- 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]>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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

📥 Commits

Reviewing files that changed from the base of the PR and between 2e8183e and b484885.

📒 Files selected for processing (2)
  • docs/oss/getting-started/quick-start.md
  • docs/pro/fragment-caching.md
✅ Files skipped from review due to trivial changes (1)
  • docs/pro/fragment-caching.md

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 28, 2026

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 node-renderer.md, streaming-ssr.md, and fragment-caching.md use plain blockquote syntax (> **Route map**:), while the rest of the docs use Docusaurus named admonitions (:::note, :::tip, etc.). Plain blockquotes render as unstyled gray boxes in Docusaurus. Consider switching to a consistent admonition style, e.g. :::note Route map.

2. RSC page is missing the route-map callout

Three of the four Pro feature entry-point pages get the new callout, but docs/pro/react-server-components/tutorial.md does not. If the callout pattern is intentional for reader orientation, it should be applied to the RSC tutorial too.

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 upgrading-existing-pro-app.md as the follow-on read, which is a migration guide for existing Pro users. A feature overview or architecture doc would be a more natural next step for first-time RSC explorers.

Comment thread docs/pro/node-renderer.md
Comment thread docs/pro/streaming-ssr.md
Comment thread docs/pro/fragment-caching.md
@ihabadham ihabadham merged commit fc30803 into main Mar 28, 2026
32 checks passed
@ihabadham ihabadham deleted the jg-codex/pro-routes branch March 28, 2026 18:19
justin808 added a commit that referenced this pull request Mar 28, 2026
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]>
justin808 added a commit that referenced this pull request Mar 28, 2026
…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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: define canonical Pro feature entry routes and replace mixed overview/deep-dive links

2 participants