docs: refresh setup and runtime guidance#2857
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughLowered documented Ruby minimum from 3.2+ to 3.0+ and Node minimum from 20+ to 18+ across docs; broadened package-manager guidance (npm/pnpm/Yarn/bun); revised React/RSC compatibility wording; updated package pins to 16.4.0/19.0.4 in places; changed some installer examples to use Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
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 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 |
coderabbitai
bot
added
review-needed
documentation
docs-cleanup
Greptile SummaryThis PR is a focused documentation refresh across 18 files, correcting copy-paste hazards, updating runtime floor versions, replacing the stale yalc/yarn Node Renderer debugging workflow with the current Confidence Score: 4/5Safe to merge after fixing the one React 19.0.3 security-version pin in create-without-ssr.md. The PR is a well-scoped docs pass with clear intent and consistent improvements throughout. One concrete issue remains: the fresh-install RSC snippet points users at react@19.0.3/react-dom@19.0.3, which the same PR explicitly labels as a known-security-vulnerability version requiring upgrade to 19.0.4+. That one-line fix is the only blocker. docs/pro/react-server-components/create-without-ssr.md — react@19.0.3 pin should be bumped to 19.0.4 to match the security guidance in upgrading-existing-pro-app.md Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User follows docs] --> B{Which guide?}
B --> C[create-without-ssr.md\nfresh RSC install]
B --> D[upgrading-existing-pro-app.md\nupgrade RSC]
B --> E[installation.md\nPro install]
B --> F[quick-start / tutorial\nbase install]
C --> G["yarn add react@19.0.3 ⚠️\nreact-dom@19.0.3\nreact-on-rails-rsc@19.0.4"]
D --> H["pnpm add react@19.0.4 ✅\nreact-dom@19.0.4\nreact-on-rails-rsc@19.0.4"]
E --> I["bundle add react_on_rails_pro --strict\nrails g react_on_rails:install --rsc"]
F --> J["bundle add react_on_rails --strict\nbundle exec rails g react_on_rails:install"]
G -->|"⚠️ Known CVEs in 19.0.0-19.0.3\nshould match upgrading guide"| K["Inconsistency: install path\nshould also use 19.0.4"]
H --> L[Consistent with security guidance]
Reviews (1): Last reviewed commit: "docs: refresh setup and runtime guidance" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Review: docs: refresh setup and runtime guidanceOverall this is a solid docs cleanup — the pnpm monorepo workflow, multi-package-manager guidance, and RSC version clarifications are all improvements. One security issue needs fixing before merge; a few smaller inconsistencies are worth a look too. 🔴 Security issue (must fix)
🟡 Minimum version claims vs CI coverage
🟡 RSC version range upper bound (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/pro/react-server-components/upgrading-existing-pro-app.md`:
- Line 26: The documentation currently shows a pnpm-only upgrade command ("pnpm
add react@19.0.4 react-dom@19.0.4 react-on-rails-rsc@19.0.4"); add the
equivalent npm and yarn variants so users have parity with other docs (e.g., an
npm install ... and yarn add ... line) and place them alongside the pnpm example
in the same block so all three package manager commands (pnpm, npm, yarn) are
present for the React/RSC upgrade.
In `@README.md`:
- Around line 203-204: The README currently states "Node.js >= 18" but the JS CI
workflow only runs Node 20 and 22; update either the CI or the docs: either add
Node 18 to the JS CI matrix (so the CI workflow that defines Node versions runs
18 in addition to 20 and 22) or change the README entry from "Node.js >= 18" to
"Node.js >= 20" (or to match the exact tested range), and ensure the README line
containing "Node.js >= 18" is updated accordingly so documentation matches CI
coverage.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 24914245-354c-4491-9c6f-10e28bafd1cb
📒 Files selected for processing (18)
AGENTS_USER_GUIDE.mdREADME.mddocs/README.mddocs/oss/api-reference/generator-details.mddocs/oss/building-features/node-renderer/basics.mddocs/oss/building-features/node-renderer/debugging.mddocs/oss/deployment/troubleshooting.mddocs/oss/getting-started/installation-into-an-existing-rails-app.mddocs/oss/getting-started/quick-start.mddocs/oss/getting-started/tutorial.mddocs/oss/introduction.mddocs/pro/home-pro.mddocs/pro/installation.mddocs/pro/js-memory-leaks.mddocs/pro/react-server-components/create-without-ssr.mddocs/pro/react-server-components/index.mddocs/pro/react-server-components/upgrading-existing-pro-app.mdllms.txt
docs/oss/getting-started/installation-into-an-existing-rails-app.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/pro/react-server-components/upgrading-existing-pro-app.md (1)
209-210:⚠️ Potential issue | 🟡 MinorMake the troubleshooting install command package-manager-agnostic too.
This section still gives a pnpm-only install command. Add yarn/npm equivalents for consistency with the rest of the page.
Suggested patch
-- **Missing `react-on-rails-rsc` package**: Run `pnpm add react-on-rails-rsc` +- **Missing `react-on-rails-rsc` package**: Run `pnpm add react-on-rails-rsc` + (or `yarn add react-on-rails-rsc`, or `npm install react-on-rails-rsc`)Based on learnings, in all end-user documentation under
docs/, installation examples should include npm, yarn, and pnpm.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/pro/react-server-components/upgrading-existing-pro-app.md` around lines 209 - 210, The two troubleshooting bullets that currently show only pnpm commands ("Missing `react-on-rails-rsc` package" with `pnpm add react-on-rails-rsc` and the version-check bullet with `pnpm list react react-dom react-on-rails-rsc`) must be updated to include npm and yarn equivalents; replace or augment the pnpm install/list examples with three command variants (npm, yarn, pnpm) so users of any package manager can follow the instructions and keep wording consistent with the rest of the docs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/pro/react-server-components/upgrading-existing-pro-app.md`:
- Around line 209-210: The two troubleshooting bullets that currently show only
pnpm commands ("Missing `react-on-rails-rsc` package" with `pnpm add
react-on-rails-rsc` and the version-check bullet with `pnpm list react react-dom
react-on-rails-rsc`) must be updated to include npm and yarn equivalents;
replace or augment the pnpm install/list examples with three command variants
(npm, yarn, pnpm) so users of any package manager can follow the instructions
and keep wording consistent with the rest of the docs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 217d2c28-764c-4d09-86e0-fd5ba18e5418
📒 Files selected for processing (5)
README.mddocs/oss/building-features/node-renderer/debugging.mddocs/pro/react-server-components/create-without-ssr.mddocs/pro/react-server-components/index.mddocs/pro/react-server-components/upgrading-existing-pro-app.md
✅ Files skipped from review due to trivial changes (2)
- README.md
- docs/oss/building-features/node-renderer/debugging.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/pro/react-server-components/create-without-ssr.md
|
Overall this is a solid docs-only cleanup pass. The runtime floor corrections (Ruby 3.0+ / Node 18+) match the gemspec and the create-react-on-rails-app package engines field, so those changes are factually grounded.\n\nIssues found:\n\n1. Missed version bump in docs/oss/getting-started/quick-start.md — Line 11 still reads React on Rails 16.4.0+ while every other version reference in this PR was updated to 16.5.0.\n\n2. Missing bun add option in docs/oss/getting-started/installation-into-an-existing-rails-app.md — The PR adds bun to the supported package manager list in README, quick-start, and node-renderer basics, but the install snippet here only shows npm / yarn / pnpm.\n\n3. Evergreen concern in docs/pro/react-server-components/create-without-ssr.md — The replaced note dropped the context explaining why the version pin exists (minor-version RSC bundler API instability per the React docs). The new note says the example uses the current stable 19.0.4 line, which will silently go stale as new patches ship.\n\nMinor observations (no action required):\n\n- node-renderer/debugging.md now points to react_on_rails_pro/spec/dummy. The Node Renderer is a Pro feature so this is appropriate, but a brief note that the workflow assumes the Pro monorepo checkout could save confusion for OSS-only readers.\n- git commit -am to git add . and git commit -m in the tutorial is a good correctness fix.\n- bundle add --strict in llms.txt and the addition of bundle exec before generator calls are both good fixes.\n- The docs/README.md changelog link now points at the raw GitHub URL instead of a dead docs route — correct call. |
ReviewGood, focused docs pass. The changes are accurate and well-scoped. A few notes: Verified correct:
Minor inconsistency (inline): |
`bun pm ls` lists all packages and ignores the package name argument. The correct bun equivalent for checking a specific package (like `npm ls <pkg>` / `yarn why <pkg>` / `pnpm list <pkg>`) is `bun pm why <pkg>`. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Review: docs refresh (setup and runtime guidance)Overall this is a good docs cleanup pass. The version floor corrections are confirmed accurate: the gemspec requires >= 3.0.0 and the Node validator warns below 18, so both changes are correct. The prerender_caching default fix is also accurate (DEFAULT_PRERENDER_CACHING = false in configuration.rb). A few things to address: 1. Tilde constraint still pins to 19.0.x in the upgrade guide In upgrading-existing-pro-app.md the upgrade command uses ~19.0.4 (>=19.0.4 <19.1.0), but the PR's stated goal is to remove the '19.0.x only' restriction. If React 19.1.x+ is now supported, these commands should use ^19.0.4 or just version-agnostic guidance. If 19.0.x is still the limit, the vague 'React 19 with a compatible react-on-rails-rsc version' language added elsewhere needs to be more specific. 2. Version pinning inconsistency between guides create-without-ssr.md pins exact 19.0.4 while upgrading-existing-pro-app.md uses tilde ~19.0.4. Both serve different purposes but aligned guidance (with a note explaining why exact vs. range) would reduce user confusion. 3. The local docs/oss/upgrading/changelog.md file still exists The docs/README.md changelog link now points to the GitHub URL, which fixes the published docs site. However, the local docs/oss/upgrading/changelog.md file (a full changelog copy) is now silently orphaned — nothing links to it. Consider either removing the file, adding a redirect note, or keeping the relative link alongside the GitHub URL. Minor: pnpm run build in debugging.md The new debugging instructions add pnpm run build at the repo root (step 1). If the Pro sub-package build script is not named build in the monorepo workspace root, this will silently do nothing or fail. Worth verifying the exact pnpm script name. |
The Procfile.dev already starts the renderer with --inspect and debug logging. Most developers will have the app running via bin/dev, so the debugging guide should start there before describing the manual per-terminal approach for isolated debugging. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
| @@ -32,8 +32,8 @@ | |||
| gem search react_on_rails --remote | |||
|
|
|||
| # Verify prerequisites | |||
There was a problem hiding this comment.
The AI agent guide now recommends the bare minimum versions (3.0+/18+) rather than the CI-tested range. Agents following these instructions may set up environments that work but haven't been validated by CI. Consider keeping the CI-tested range here to bias agents toward well-tested configurations:
| # Verify prerequisites | |
| ruby -v # Should be 3.2+ (CI tested: 3.2 - 3.4; minimum: 3.0) | |
| node -v # Should be 20+ (CI tested: 20 - 22; minimum: 18) |
| @@ -200,8 +200,8 @@ _Requires creating a free account._ | |||
|
|
|||
| - Ruby on Rails >= 5 | |||
| - Shakapacker >= 6.0 (CI tested: 8.2.0 - 9.5.0; autobundling requires >= 7.0) | |||
There was a problem hiding this comment.
The phrase "package minimum" implies this is enforced by a package metadata field (e.g. engines in package.json), but neither packages/react-on-rails/package.json nor the monorepo root package.json currently declares an engines.node constraint. This is an asserted minimum, not a formally enforced one. Either add an engines field to back up the claim, or rephrase to "documented minimum" to avoid confusion.
|
|
||
| ```bash | ||
| yarn add react@19.0.0 react-dom@19.0.0 react-on-rails-rsc@19.0.0 | ||
| yarn add react@19.0.4 react-dom@19.0.4 react-on-rails-rsc@19.0.4 |
There was a problem hiding this comment.
The react-on-rails-rsc package is pinned to 19.0.4 in the same command as React 19.0.4, which implies its version tracks React's — but that's not obvious to readers. The note below explains "update to the latest 19.x patch", which suggests the RSC package version intentionally mirrors React's version number. A brief explanation of this convention (e.g. "the react-on-rails-rsc version should match your React version") would prevent confusion when users try to find react-on-rails-rsc@19.1.x after upgrading React.
| ```bash | ||
| pnpm add react@~19.0.4 react-dom@~19.0.4 | ||
| pnpm add react@~19.0.4 react-dom@~19.0.4 react-on-rails-rsc@~19.0.4 | ||
| # or: yarn add react@~19.0.4 react-dom@~19.0.4 react-on-rails-rsc@~19.0.4 |
There was a problem hiding this comment.
The tilde constraint ~19.0.4 allows only 19.0.4 – 19.0.x (patch range). But the broader note in this PR loosens the language to "React 19 with a compatible react-on-rails-rsc version", implying 19.1.x+ could eventually be allowed. This tilde is internally consistent with the security callout ("19.0.4+ is recommended … earlier 19.0.x have vulnerabilities"), but it contradicts the looser RSC wording elsewhere. Consider an explicit comment like # keeps within 19.0.x; see note below to make the intent clear.
| - React on Rails Pro v4.0.0 or higher | ||
| - React 19.0.x (19.1.x and later are not yet supported) | ||
| - React on Rails v16.0.0 or higher | ||
| - React on Rails Pro v16.4.0 or higher |
There was a problem hiding this comment.
The old requirement listed "React on Rails Pro v4.0.0 or higher", which was a much lower bar. Bumping the documented minimum to v16.4.0 is a significant change — users on v4–v16.3 who relied on that section as a compatibility baseline would now see a different requirement. If there was any RSC support before v16.4.0, a brief deprecation note (e.g. "RSC support was significantly revised in v16.4.0; earlier versions had partial support") would help users on older versions understand what changed.
|
Solid documentation cleanup overall. The prerender_caching correction and debugging workflow rewrite are both verified accurate against source code and Procfiles. Five issues flagged with inline comments: (1) AGENTS_USER_GUIDE.md drops recommended versions to minimum rather than CI-tested range, which could cause AI agents to pick under-tested environments; (2) README 'package minimum' for Node 18 is not backed by an engines field in package.json; (3) react-on-rails-rsc version-mirroring convention is unexplained in create-without-ssr.md; (4) upgrading guide uses ~19.0.4 tilde but PR language allows React 19 broadly - the intent should be explicit; (5) RSC minimum quietly jumped from v4 to v16.4 without a migration note. On the positive side: prerender_caching fix is accurate (DEFAULT_PRERENDER_CACHING = false confirmed at react_on_rails_pro/lib/react_on_rails_pro/configuration.rb:48), the debugging section replacement matches the actual Procfile.dev and package.json scripts in the Pro dummy app, loosening React 19.0.x to 'React 19 with compatible react-on-rails-rsc' is the right direction, and the bundle exec and --strict additions to llms.txt are good hygiene. |
## 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) <!-- CURSOR_SUMMARY --> --- > [!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> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated changelog to document version 16.5.1 release with consolidated version history and updated comparison links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…olve-2835 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2849 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2828 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2834 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2833 * origin/main: Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # CHANGELOG.md
…olve-2661 * origin/main: Clarify streaming narrative in RSC docs (#2813) (#2814) Bump version to 16.5.1 Update CHANGELOG.md for 16.5.1 (#2873) fix: include lib/tasks/ in pro gem so rake tasks are available (#2872) docs: clarify how React on Rails compares to alternatives (#2856) docs: fix published setup guidance gaps (#2860) docs: refresh setup and runtime guidance (#2857) docs: refresh pro upgrade examples (#2859) docs: modernize dependency update commands (#2864) Update spec/dummy Gemfile.lock for async >= 2.29 (#2870) # Conflicts: # docs/oss/migrating/rsc-data-fetching.md
## Summary This applies another docs review pass focused on current copy-paste hazards and published-site mismatches. Changes in this PR: - fix broken setup snippets in `llms.txt` and the tutorial/install guides - refresh documented runtime floors to match current validators and gemspec support (`Ruby 3.0+`, `Node 18+`) - replace stale Node Renderer debugging steps with the current `pnpm` + Pro dummy app workflow - fix the docs landing page changelog link so the published docs site no longer points at a dead route - refresh Pro/RSC entry docs to current version guidance and supported `react-on-rails-rsc` compatibility wording - fix the bad Pro link in `docs/pro/js-memory-leaks.md` Follow-up filed separately: - shakacode/reactonrails.com#63 for missing legacy `/docs/guides/*` redirects on the site ## Test plan - `pnpm run lint` - `pnpm start format.listDifferent` - `git diff --check` - `lychee --offline --no-progress --format compact llms.txt README.md AGENTS_USER_GUIDE.md docs/README.md docs/oss/api-reference/generator-details.md docs/oss/building-features/node-renderer/basics.md docs/oss/building-features/node-renderer/debugging.md docs/oss/deployment/troubleshooting.md docs/oss/getting-started/installation-into-an-existing-rails-app.md docs/oss/getting-started/quick-start.md docs/oss/getting-started/tutorial.md docs/oss/introduction.md docs/pro/home-pro.md docs/pro/installation.md docs/pro/js-memory-leaks.md docs/pro/react-server-components/create-without-ssr.md docs/pro/react-server-components/index.md docs/pro/react-server-components/upgrading-existing-pro-app.md` - verified live destinations return `200`: - `https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.md` - `https://reactonrails.com/docs/pro/` - `https://pro.reactonrails.com/` ## Notes - `bundle exec rubocop` still fails on the repo baseline due hundreds of unrelated existing offenses in generated/bin and legacy files; this PR changes no `.rb` files. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only updates adjusting stated runtime minimums and setup/debugging instructions; no code or runtime behavior changes. > > **Overview** > Updates docs to reflect **minimum supported runtimes** (Ruby `3.0+`, Node `18+`) and modernizes setup snippets to be more copy/paste-safe (e.g., `bundle add ... --strict`, `bundle exec rails generate ...`, and package-manager-agnostic install commands including `bun`). > > Refreshes **Pro / Node Renderer / RSC** documentation: replaces stale renderer debugging instructions with the current `pnpm` monorepo dummy-app workflow, clarifies RSC compatibility as “React 19 + compatible `react-on-rails-rsc`”, and fixes/updates links (notably the docs changelog URL and Pro docs link in `js-memory-leaks.md`). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 5acee11. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Lowered documented minimums: Ruby 3.0+ and Node.js 18+; CI-tested ranges unchanged. * Made install/setup steps package-manager-agnostic (npm/pnpm/Yarn/bun) and added bun guidance. * Clarified React Server Components compatibility and updated Pro/prerequisite guidance to v16.4.0 with example React/RSC pins (19.0.4). * Strengthened generator/install instructions to use Bundler/strict flags. * Improved debugging/monorepo workflow, troubleshooting guidance, and changelog/navigation links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: ihabadham <ihabadham4p@gmail.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
## 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) <!-- CURSOR_SUMMARY --> --- > [!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> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated changelog to document version 16.5.1 release with consolidated version history and updated comparison links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 participants
Summary
This applies another docs review pass focused on current copy-paste hazards and published-site mismatches.
Changes in this PR:
llms.txtand the tutorial/install guidesRuby 3.0+,Node 18+)pnpm+ Pro dummy app workflowreact-on-rails-rsccompatibility wordingdocs/pro/js-memory-leaks.mdFollow-up filed separately:
/docs/guides/*redirects on the siteTest plan
pnpm run lintpnpm start format.listDifferentgit diff --checklychee --offline --no-progress --format compact llms.txt README.md AGENTS_USER_GUIDE.md docs/README.md docs/oss/api-reference/generator-details.md docs/oss/building-features/node-renderer/basics.md docs/oss/building-features/node-renderer/debugging.md docs/oss/deployment/troubleshooting.md docs/oss/getting-started/installation-into-an-existing-rails-app.md docs/oss/getting-started/quick-start.md docs/oss/getting-started/tutorial.md docs/oss/introduction.md docs/pro/home-pro.md docs/pro/installation.md docs/pro/js-memory-leaks.md docs/pro/react-server-components/create-without-ssr.md docs/pro/react-server-components/index.md docs/pro/react-server-components/upgrading-existing-pro-app.md200:https://github.com/shakacode/react_on_rails/blob/main/CHANGELOG.mdhttps://reactonrails.com/docs/pro/https://pro.reactonrails.com/Notes
bundle exec rubocopstill fails on the repo baseline due hundreds of unrelated existing offenses in generated/bin and legacy files; this PR changes no.rbfiles.Note
Low Risk
Low risk: documentation-only updates adjusting stated runtime minimums and setup/debugging instructions; no code or runtime behavior changes.
Overview
Updates docs to reflect minimum supported runtimes (Ruby
3.0+, Node18+) and modernizes setup snippets to be more copy/paste-safe (e.g.,bundle add ... --strict,bundle exec rails generate ..., and package-manager-agnostic install commands includingbun).Refreshes Pro / Node Renderer / RSC documentation: replaces stale renderer debugging instructions with the current
pnpmmonorepo dummy-app workflow, clarifies RSC compatibility as “React 19 + compatiblereact-on-rails-rsc”, and fixes/updates links (notably the docs changelog URL and Pro docs link injs-memory-leaks.md).Written by Cursor Bugbot for commit 5acee11. This will update automatically on new commits. Configure here.
Summary by CodeRabbit