Skip to content

docs: refresh pro upgrade examples#2859

Merged
ihabadham merged 2 commits intomainfrom
jg-codex/docs-review-pass-4
Mar 27, 2026
Merged

docs: refresh pro upgrade examples#2859
ihabadham merged 2 commits intomainfrom
jg-codex/docs-review-pass-4

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 26, 2026

Summary

Second non-overlapping docs pass focused on current Pro upgrade examples that still needed cleanup outside of #2857.

Changes in this PR:

  • add a bun variant to the Pro npm-package swap example for package-manager parity
  • update docs/pro/streaming-ssr.md from react / react-dom 19.0.0 examples to 19.0.4
  • clarify the streaming note to prefer the latest compatible React 19 patch release

This is intentionally separate from #2857 so it can merge independently.

Test plan

  • pnpm start format.listDifferent
  • git diff --check
  • lychee --offline --no-progress --format compact docs/pro/upgrading-to-pro.md docs/pro/streaming-ssr.md

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

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Mar 26, 2026

Review: docs: refresh pro upgrade examples

This is a clean, low-risk documentation-only PR. All changes look accurate and well-considered.

Version bumps16.5.0 is confirmed released in the CHANGELOG (2026-03-25), and 19.0.4 is a valid React 19 patch. Both version updates are appropriate.

Bun variantbun add react-on-rails-pro@16.5.0 --exact is the correct syntax for bun (bun uses --exact, not --save-exact), and it's consistent with the yarn example above it.

Improved streaming note — "Use the latest React 19 patch release that is compatible with your app and tooling." is actionable and more helpful than the previous wording that just pointed to React docs.

No issues found. LGTM.

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Mar 26, 2026

Greptile Summary

This is a focused documentation refresh that keeps illustrative version numbers in the Pro upgrade guides in sync with actual releases. It bumps the react_on_rails_pro example version from 16.4.0 to 16.5.0 (released 2026-03-25 per CHANGELOG), bumps the streaming SSR React example from 19.0.0 to 19.0.4, and adds a bun package-manager variant alongside the existing npm/yarn/pnpm examples.

Key changes:

  • docs/pro/upgrading-to-pro.md — All five 16.4.0 occurrences (version note, RC note, Gemfile snippet, bundle add command, fresh-install command) updated to 16.5.0.
  • docs/pro/upgrading-to-pro.md — New # bun block added: bun remove react-on-rails && bun add react-on-rails-pro@16.5.0 --exact; syntax verified correct against Bun's official CLI reference.
  • docs/pro/streaming-ssr.mdreact / react-dom example pins bumped from 19.0.019.0.4.
  • docs/pro/streaming-ssr.md — Streaming note reworded from "Check the React documentation for the latest release" to the more actionable "Use the latest React 19 patch release that is compatible with your app and tooling."

Confidence Score: 5/5

Safe to merge — purely documentation updates with no logic changes; all version numbers verified and bun CLI syntax is correct.

Both version bumps are consistent with actual releases (16.5.0 confirmed in CHANGELOG, React 19.0.4 is a real patch release). The new bun commands use the correct bun remove / bun add --exact flags as documented in Bun's official CLI reference. No broken links or contradictory instructions introduced.

No files require special attention.

Important Files Changed

Filename Overview
docs/pro/upgrading-to-pro.md Version references updated from 16.4.0 to 16.5.0 (matches CHANGELOG release 2026-03-25); bun package manager variant added with correct bun remove / bun add --exact syntax.
docs/pro/streaming-ssr.md React and react-dom example versions bumped from 19.0.0 to 19.0.4; streaming note reworded to be more actionable ("latest compatible patch" vs. "check the docs").

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([Start: Existing RoR app]) --> B[Step 1: Swap gem\nbundle remove react_on_rails\nbundle add react_on_rails_pro --version '= 16.5.0']
    B --> C[Step 2: Swap npm package\nnpm / yarn / pnpm / bun]
    C --> D[Update imports\nreact-on-rails-pro]
    D --> E[Step 3: Run Pro generator\nbundle exec rails generate react_on_rails:pro]
    E --> F[Verify\nreact_on_rails:doctor + bin/dev]
    F --> G([Done: App running React on Rails Pro])
Loading

Reviews (1): Last reviewed commit: "docs: refresh pro upgrade examples" | Re-trigger Greptile

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

Walkthrough

Two documentation files updated: React version pins increased from 19.0.0 to 19.0.4 with revised guidance in streaming-ssr documentation, and bun package manager installation instructions added to the upgrading-to-pro guide.

Changes

Cohort / File(s) Summary
React Version Updates
docs/pro/streaming-ssr.md
Updated example React dependency from 19.0.0 to 19.0.4 patch version and replaced release guidance note with version compatibility instruction.
Package Manager Support
docs/pro/upgrading-to-pro.md
Added bun installation section with explicit --exact flag commands for removing and adding react-on-rails-pro dependency.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop and a skip through the docs so fine,
React's patched up nicely at version nine-point-four,
And bun joins the dance, no more left behind,
With pins held tight, we're compatible and more! 📦✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: refresh pro upgrade examples' accurately reflects the main changes: updating documentation examples with refreshed version pins and adding a bun variant to upgrade instructions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg-codex/docs-review-pass-4

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

claude bot commented Mar 26, 2026

Review

The changes look clean overall. One discrepancy worth resolving:

PR description vs. actual diff mismatch — the summary claims this PR updates docs/pro/upgrading-to-pro.md "from illustrative 16.4.0 commands to 16.5.0", but the diff only adds the new bun example line (with 16.4.0) and leaves every other version reference unchanged (gem examples at lines 30, 39, 93; npm/yarn/pnpm examples at lines 50, 53, 56). Either the description is wrong (the version bump was actually intended for a different PR), or the 16.4.0 → 16.5.0 sweep was accidentally omitted from this commit.

Everything else is straightforward:

  • React/react-dom bump to 19.0.4 is accurate and the updated note text is clearer.
  • bun add --exact is the correct bun flag for exact-version pinning (mirrors yarn's --exact / npm's --save-exact). The command syntax is valid.

@ihabadham ihabadham merged commit 7e4901a into main Mar 27, 2026
13 checks passed
@ihabadham ihabadham deleted the jg-codex/docs-review-pass-4 branch March 27, 2026 20:12
@justin808 justin808 mentioned this pull request Mar 28, 2026
2 tasks
justin808 added a commit that referenced this pull request Mar 28, 2026
## 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>
justin808 added a commit that referenced this pull request Mar 28, 2026
…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
justin808 added a commit that referenced this pull request Mar 28, 2026
…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
justin808 added a commit that referenced this pull request Mar 28, 2026
…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
justin808 added a commit that referenced this pull request Mar 28, 2026
…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
justin808 added a commit that referenced this pull request Mar 28, 2026
…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
justin808 added a commit that referenced this pull request Mar 28, 2026
…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
justin808 added a commit that referenced this pull request Mar 28, 2026
Update Pro upgrade docs with current versions and package-manager parity.

- Bump React example pins from 19.0.0 to 19.0.4 in streaming SSR guide
- Add bun variant to the Pro npm-package swap example
- Clarify streaming note to recommend latest compatible React 19 patch

Co-Authored-By: Justin Gordon <justin@shakacode.com>
justin808 added a commit that referenced this pull request Mar 28, 2026
## 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants