-
-
Notifications
You must be signed in to change notification settings - Fork 635
docs: refresh setup and runtime guidance #2857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
1fed1aa
294ce30
f025787
ef5fe8c
5acee11
12cc98b
bf22fe1
0e94ac4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The phrase "package minimum" implies this is enforced by a package metadata field (e.g. |
||
| - Ruby >= 3.2 (CI tested: 3.2 - 3.4) | ||
| - Node.js >= 20 (CI tested: 20 - 22) | ||
| - Ruby >= 3.0 (package minimum; CI tested: 3.2 - 3.4) | ||
| - Node.js >= 18 (package minimum; CI tested: 20 - 22) | ||
| - A JavaScript package manager (npm, yarn, pnpm, or bun) | ||
|
|
||
| # 🆘 Get Help & Support | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,13 +23,14 @@ React on Rails installs the matching `react-on-rails` JavaScript package during | |
| If you manage versions manually, keep the Ruby gem and npm package on the same release. Pre-release gems use dots while npm uses hyphens. | ||
|
|
||
| ```ruby | ||
| gem "react_on_rails", "16.4.0.rc.10" | ||
| gem "react_on_rails", "16.4.0" | ||
| ``` | ||
|
|
||
| ```bash | ||
| npm install [email protected] --save-exact | ||
| # or: yarn add [email protected] --exact | ||
| # or: pnpm add [email protected] --save-exact | ||
| npm install [email protected] --save-exact | ||
| # or: yarn add [email protected] --exact | ||
| # or: pnpm add [email protected] --save-exact | ||
| # or: bun add [email protected] --exact | ||
| ``` | ||
|
|
||
| ## 2. Run the generator | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ To use Server Components in your React on Rails Pro project, you need to follow | |
| yarn add --exact [email protected] | ||
| # npm install --save-exact [email protected] | ||
| # pnpm add --save-exact [email protected] | ||
ihabadham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # bun add --exact [email protected] | ||
|
|
||
| # Then add the Ruby gems: | ||
| bundle add react_on_rails --version "16.4.0" --strict | ||
ihabadham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
@@ -24,11 +25,17 @@ bundle add react_on_rails_pro --version "16.4.0" --strict | |
| Also, install version 19 of React, React DOM, and `react-on-rails-rsc`: | ||
|
|
||
| ```bash | ||
| yarn add [email protected] [email protected] [email protected] | ||
| yarn add [email protected] [email protected] [email protected] | ||
ihabadham marked this conversation as resolved.
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
| # npm install [email protected] [email protected] [email protected] | ||
| # pnpm add [email protected] [email protected] [email protected] | ||
| # bun add [email protected] [email protected] [email protected] | ||
| ``` | ||
justin808 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| > [!NOTE] | ||
| > While React Server Components in React 19 are stable, the underlying APIs used to implement React Server Components bundlers may break between minor versions (19.x). According to the [React Documentation](https://react.dev/reference/rsc/server-components#how-do-i-build-support-for-server-components). React on Rails Pro currently only supports React 19.0.x. | ||
| > React on Rails Pro currently supports React 19 with a compatible `react-on-rails-rsc` version. | ||
justin808 marked this conversation as resolved.
Show resolved
Hide resolved
ihabadham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| > The example above pins `19.0.4`; update to the latest `19.x` patch that your `react-on-rails-rsc` | ||
| > compatibility range allows. The RSC bundler APIs used internally can change between React minor | ||
| > versions. See the [React documentation on Server Components](https://react.dev/reference/rsc/server-components#how-do-i-build-support-for-server-components) for details. | ||
|
|
||
| 2. Enable support for Server Components in React on Rails Pro configuration: | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # React Server Components in React on Rails Pro | ||
|
|
||
| > **Pro Feature** — React Server Components require [React on Rails Pro](https://reactonrails.com/docs/pro/) 4+ with the node renderer. | ||
| > **Pro Feature** — React Server Components require [React on Rails Pro](https://reactonrails.com/docs/pro/) with the node renderer. | ||
| > Free or very low cost for startups and small companies. [Get a license →](https://pro.reactonrails.com/) | ||
|
|
||
| ## What Are React Server Components? | ||
|
|
@@ -34,7 +34,7 @@ Server components can access databases, file systems, and internal APIs directly | |
|
|
||
| ## Current Support Status | ||
|
|
||
| React on Rails Pro 4+ provides full RSC support with: | ||
| Current React on Rails Pro releases provide full RSC support with: | ||
|
|
||
| - RSC webpack loader (`react-on-rails-rsc/WebpackLoader`) for server/client component separation | ||
| - RSC webpack plugin (`react-on-rails-rsc/WebpackPlugin`) for client manifest generation | ||
|
|
@@ -44,9 +44,9 @@ React on Rails Pro 4+ provides full RSC support with: | |
|
|
||
| ### Requirements | ||
|
|
||
| - 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
| - React on Rails v16.4.0 or higher | ||
| - React 19 with a compatible `react-on-rails-rsc` version | ||
| - Node renderer — installed separately via `react-on-rails-pro-node-renderer` npm package (see [Pro Installation](../installation.md#install-react-on-rails-pro-node-renderer)) | ||
| - Shakapacker or Rspack for bundling | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: