docs: turn pro quick start into a gateway by justin808 · Pull Request #2862 · shakacode/react_on_rails

justin808 · 2026-03-26T21:59:13Z

Summary

Resolves #2861 by reducing docs/oss/getting-started/pro-quick-start.md to a short OSS-side gateway page instead of maintaining a second full Pro installation guide in the OSS getting-started tree.

Changes in this PR:

keep the existing live route so OSS-side discovery paths do not break
replace the duplicated Pro setup walkthrough with links to the canonical Pro installation and upgrade guides
point readers to the relevant follow-up docs for RSC, Node Renderer, and troubleshooting

Why

The old page duplicated Pro setup guidance from the OSS subtree and competed with the canonical Pro docs under /docs/pro/. That made the information architecture harder to follow and increased the chance that users or agents would land on the wrong entry point first.

Test plan

/Users/justin/codex/react_on_rails/node_modules/.bin/prettier --check docs/oss/getting-started/pro-quick-start.md
git diff --check
lychee --offline --no-progress --format compact docs/oss/getting-started/pro-quick-start.md

Note

Low Risk
Low risk: documentation-only change that removes duplicated setup instructions and replaces them with links to canonical Pro docs.

Overview
Replaces docs/oss/getting-started/pro-quick-start.md with a short gateway that preserves the existing URL but stops duplicating Pro setup instructions.

The page now directs users to the canonical Pro installation and upgrade guides, plus follow-up links for React Server Components, the Node Renderer architecture, and OSS-side troubleshooting.

^{Written by Cursor Bugbot for commit 06026b6. This will update automatically on new commits. Configure here.}

Summary by CodeRabbit

Documentation
- Redesigned Pro Quick Start guide for improved user navigation with direct links to Pro-specific installation documentation, upgrade guides, and OSS vs Pro comparisons.
- Added streamlined access to RSC documentation, Node Renderer documentation, and a comprehensive Common Issues & Quick Fixes resource for faster troubleshooting.

chatgpt-codex-connector · 2026-03-26T21:59:18Z

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

coderabbitai · 2026-03-26T21:59:25Z

Walkthrough

The Pro Quick Start guide in the OSS documentation tree was replaced with a concise gateway page. The comprehensive installation and configuration walkthrough was removed and replaced with links to canonical Pro resources, including Pro installation, upgrade guides, OSS-vs-Pro comparison, and feature documentation.

Changes

Cohort / File(s)	Summary
Documentation Gateway Page `docs/oss/getting-started/pro-quick-start.md`	Converted full Pro setup guide to short gateway page; removed all installation walkthrough and configuration snippets; added links to canonical Pro installation, Pro upgrade, OSS-vs-Pro comparison, RSC docs, Node Renderer docs, and local troubleshooting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 The Pro path once tangled in OSS-side trees,
Now points straight to canonical ease! 📍
A gateway so light, yet perfectly clear,
Guides users where they ought to steer. ✨

🚥 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 accurately and concisely describes the main change: transforming the pro-quick-start page from a full guide into a gateway page.
Linked Issues check	✅ Passed	The PR fully addresses all coding objectives from issue `#2861`: the page is now a gateway rather than a full Pro guide, OSS getting-started no longer contains the full Pro installation walkthrough, and cross-links point to canonical Pro installation/upgrade guides.
Out of Scope Changes check	✅ Passed	All changes are directly related to converting the pro-quick-start.md file into a gateway page as specified in the linked issue; no unrelated modifications are present.
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/docs-review-pass-6

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.}

claude · 2026-03-26T22:00:25Z

Review: Documentation gateway refactor

This is a clean, focused documentation change. Verified:

All 6 relative links resolve to real files:
- ../../pro/installation.md#fresh-installation — file exists, heading ## Fresh Installation produces the correct anchor
- ../../pro/upgrading-to-pro.md — ✓
- ./oss-vs-pro.md — ✓
- ../../pro/react-server-components/index.md — ✓
- ../../pro/node-renderer.md — ✓
- ./common-issues.md — ✓

The approach is sound: preserving the URL while replacing duplicated content with a gateway avoids the info-architecture problem described in the PR without breaking any existing inbound links.

One minor suggestion: the page intro refers to "the Pro docs section" without a hyperlink. Linking that phrase directly (e.g. to ../../pro/home-pro.md or wherever the Pro docs landing page is) would make it easier for readers to orient themselves before they pick a path.

Otherwise LGTM — no code changes, no security surface, and no behavioral risk.

greptile-apps · 2026-03-26T22:00:36Z

Greptile Summary

This PR converts docs/oss/getting-started/pro-quick-start.md from a full, duplicated Pro installation walkthrough into a concise gateway page that routes OSS-side readers to the canonical Pro docs. The existing URL is preserved, so no inbound links break.\n\nKey changes:\n- Strips the 184-line step-by-step Pro setup guide\n- Adds three "Choose your path" links (fresh install, upgrade, OSS-vs-Pro comparison) and three "After setup" links\n- All six relative links were verified to resolve to real files and, where applicable, to the correct anchors (#fresh-installation in docs/pro/installation.md)

Confidence Score: 5/5

Safe to merge — documentation-only change with all links verified

Single markdown file touched; every relative link resolves to an existing file and correct anchor; no code or config changes; the URL path is unchanged so existing deep-links continue to work

No files require special attention

Important Files Changed

Filename	Overview
docs/oss/getting-started/pro-quick-start.md	184-line Pro setup walkthrough replaced with a 17-line gateway page; all six relative links verified against real files and anchors in the repo

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["OSS discovery path\n(pro-quick-start.md)"] --> B{Where are you?}
    B -->|New Pro app| C["docs/pro/installation.md\n#fresh-installation"]
    B -->|Upgrading from OSS| D["docs/pro/upgrading-to-pro.md"]
    B -->|Comparing OSS vs Pro| E["docs/oss/getting-started/oss-vs-pro.md"]
    A --> F[After Setup]
    F --> G["docs/pro/react-server-components/index.md"]
    F --> H["docs/pro/node-renderer.md"]
    F --> I["docs/oss/getting-started/common-issues.md"]

_{Reviews (1): Last reviewed commit: "docs: turn pro quick start into a gatewa..." | Re-trigger Greptile}

claude · 2026-03-26T22:00:37Z

+# React on Rails Pro: Start Here

-This guide walks you through creating a complete React on Rails Pro application with server-side rendering via the Node Renderer, from an empty directory to a running app.
+React on Rails Pro has its canonical installation and upgrade guides in the Pro docs section. This


The phrase "the Pro docs section" would be more helpful as a hyperlink. Readers who aren't sure where that section lives will benefit from a direct link to the Pro docs landing page.

Suggested change

React on Rails Pro has its canonical installation and upgrade guides in the Pro docs section. This

React on Rails Pro has its canonical installation and upgrade guides in the [Pro docs section](../../pro/home-pro.md). This

coderabbitai

🧹 Nitpick comments (1)

docs/oss/getting-started/pro-quick-start.md (1)
7-7: Optional wording polish for the heading

“Choose the Right Pro Path” is clear, but if you want to reduce repeated “right” nearby, consider “Choose Your Pro Path.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/oss/getting-started/pro-quick-start.md` at line 7, Heading wording
“Choose the Right Pro Path” is fine but could avoid repeating “right” elsewhere;
change the heading text string "Choose the Right Pro Path" to "Choose Your Pro
Path" in the markdown so it reads more concise and natural (update the header
token that contains "Choose the Right Pro Path" to "Choose Your Pro Path").

🤖 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/pro-quick-start.md`:
- Line 7: Heading wording “Choose the Right Pro Path” is fine but could avoid
repeating “right” elsewhere; change the heading text string "Choose the Right
Pro Path" to "Choose Your Pro Path" in the markdown so it reads more concise and
natural (update the header token that contains "Choose the Right Pro Path" to
"Choose Your Pro Path").

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e3156587-f1ae-4fb0-b79e-90c962aa8381

📥 Commits

Reviewing files that changed from the base of the PR and between 9b30cc1 and 06026b6.

📒 Files selected for processing (1)

docs/oss/getting-started/pro-quick-start.md

…olve-2833 * origin/main: docs: fix profiling node renderer command (#2863) generators: point Pro install fallback to upgrade guide (#2868) Add RSC Flight payload optimization guide (Article 7) (#2827) Migrate from deprecated Async::Variable to Async::Promise (#2832) docs: turn pro quick start into a gateway (#2862) Fix upload-assets endpoint duplicating bundles across directories (#2768) docs: fix stale docs links and help URLs (#2850) docs: replace dead pro.reactonrails.com links (#2851) docs: refresh generator and helper URLs (#2852) Add standalone RSC upgrade guide for existing Pro apps (#2831) Raise docs version floor to 16.4.0 in install/demo guidance (#2610) # Conflicts: # CHANGELOG.md

…olve-2834 * origin/main: docs: fix profiling node renderer command (#2863) generators: point Pro install fallback to upgrade guide (#2868) Add RSC Flight payload optimization guide (Article 7) (#2827) Migrate from deprecated Async::Variable to Async::Promise (#2832) docs: turn pro quick start into a gateway (#2862) Fix upload-assets endpoint duplicating bundles across directories (#2768) docs: fix stale docs links and help URLs (#2850) docs: replace dead pro.reactonrails.com links (#2851) docs: refresh generator and helper URLs (#2852) # Conflicts: # CHANGELOG.md # react_on_rails/lib/react_on_rails/utils.rb

…olve-2849 * origin/main: docs: fix profiling node renderer command (#2863) generators: point Pro install fallback to upgrade guide (#2868) Add RSC Flight payload optimization guide (Article 7) (#2827) Migrate from deprecated Async::Variable to Async::Promise (#2832) docs: turn pro quick start into a gateway (#2862) Fix upload-assets endpoint duplicating bundles across directories (#2768) docs: fix stale docs links and help URLs (#2850) docs: replace dead pro.reactonrails.com links (#2851) docs: refresh generator and helper URLs (#2852) Add standalone RSC upgrade guide for existing Pro apps (#2831) Raise docs version floor to 16.4.0 in install/demo guidance (#2610) # Conflicts: # CHANGELOG.md

…olve-2835 * origin/main: (21 commits) docs: fix profiling node renderer command (#2863) generators: point Pro install fallback to upgrade guide (#2868) Add RSC Flight payload optimization guide (Article 7) (#2827) Migrate from deprecated Async::Variable to Async::Promise (#2832) docs: turn pro quick start into a gateway (#2862) Fix upload-assets endpoint duplicating bundles across directories (#2768) docs: fix stale docs links and help URLs (#2850) docs: replace dead pro.reactonrails.com links (#2851) docs: refresh generator and helper URLs (#2852) Add standalone RSC upgrade guide for existing Pro apps (#2831) Raise docs version floor to 16.4.0 in install/demo guidance (#2610) Fix release script: require changelog, fix RC version computation (#2848) Bump version to 16.5.0 Bump version to 16.5.0.rc.0 Update CHANGELOG.md for 16.5.0.rc.0 (#2847) Docs: add memory leak prevention guide for Node Renderer SSR (#2845) Docs: fix RSC migration gaps found during real-world migration (#2842) Add common mistakes sections to RSC migration guides (#2826) fix: preserve runtime env vars across Bundler.with_unbundled_env (#2836) Skip Pro CI workflows for Dependabot PRs (#2825) ... # Conflicts: # CHANGELOG.md

## Summary - Stamped `### [16.5.1] - 2026-03-27` with two Pro fixes (PRs #2872, #2768) - Removed the `### [16.5.0.rc.0]` section (was already released as 16.5.0 stable) - Consolidated the 16.5.0 section with full entries (previously just said "no changes from rc.0") - Updated diff links at bottom of file ## Skipped PRs (docs/internal only) #2856, #2860, #2857, #2859, #2864, #2870, #2863, #2868, #2827, #2862, #2850, #2851, #2852, #2831, #2610, #2848 ## Test plan - [ ] Verify CHANGELOG.md formatting and diff links are correct - [ ] Run `rake release` (no args) after merge to publish 16.5.1 🤖 Generated with [Claude Code](https://claude.com/claude-code)  --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to `CHANGELOG.md` release notes and version/compare links with no runtime code modifications. > > **Overview** > Documents the `16.5.1` release by adding a new section under *Unreleased* with two **[Pro]** fixes (missing packaged rake tasks and avoiding duplicated bundles during remote renderer asset uploads). > > Cleans up the `16.5.0` entry by removing the `16.5.0.rc.0` section and updating the compare-link footer so `unreleased` now starts from `v16.5.1` and `16.5.0` compares from `v16.4.0`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 9a6b224. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>   ## Summary by CodeRabbit * **Documentation** * Updated changelog to document version 16.5.1 release with consolidated version history and updated comparison links.  Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>

docs: turn pro quick start into a gateway

06026b6

claude Bot reviewed Mar 26, 2026

View reviewed changes

coderabbitai Bot reviewed Mar 26, 2026

View reviewed changes

coderabbitai Bot approved these changes Mar 26, 2026

View reviewed changes

justin808 merged commit cc39029 into main Mar 26, 2026
13 checks passed

justin808 deleted the jg-codex/docs-review-pass-6 branch March 26, 2026 23:17

justin808 mentioned this pull request Mar 28, 2026

Update CHANGELOG.md for 16.5.1 #2873

Merged

2 tasks

justin808 mentioned this pull request Apr 3, 2026

Docs onboarding follow-up: consolidate comparison pages and remaining entry-point overlap #2927

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: turn pro quick start into a gateway#2862

docs: turn pro quick start into a gateway#2862
justin808 merged 1 commit intomainfrom
jg-codex/docs-review-pass-6

justin808 commented Mar 26, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

chatgpt-codex-connector Bot commented Mar 26, 2026

Uh oh!

coderabbitai Bot commented Mar 26, 2026 •

edited

Loading

Uh oh!

claude Bot commented Mar 26, 2026

Uh oh!

greptile-apps Bot commented Mar 26, 2026

Uh oh!

claude Bot Mar 26, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	React on Rails Pro has its canonical installation and upgrade guides in the Pro docs section. This
	React on Rails Pro has its canonical installation and upgrade guides in the [Pro docs section](../../pro/home-pro.md). This

Uh oh!

Conversation

justin808 commented Mar 26, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Why

Test plan

Summary by CodeRabbit

Uh oh!

chatgpt-codex-connector Bot commented Mar 26, 2026

Uh oh!

coderabbitai Bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

claude Bot commented Mar 26, 2026

Uh oh!

greptile-apps Bot commented Mar 26, 2026

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Flowchart

Uh oh!

claude Bot Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

justin808 commented Mar 26, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 26, 2026 •

edited

Loading