Improve package metadata and Pro upgrade CTAs#3112
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (7)
WalkthroughThis PR updates package metadata and documentation references across React on Rails projects. Changes include updating repository directory fields, redirecting homepage URLs from GitHub to reactonrails.com documentation, adding comprehensive gemspec metadata, and enhancing READMEs with information about React on Rails Pro offerings. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 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 docstrings
🧪 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 |
Greptile SummaryThis PR updates package metadata and post-install messaging to improve discoverability by pointing gem and npm homepages to Confidence Score: 5/5Safe to merge — purely metadata and documentation changes with no runtime impact. All changes are metadata fields (gemspec, package.json), README documentation, and a post_install_message rewrite. No library code, no migrations, no API surface changes. Heredoc syntax is correct, dependency reordering in the Pro gemspec is non-functional, and all remaining findings are P2 at most. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User discovers react_on_rails] --> B{Discovery channel}
B -->|RubyGems| C[react_on_rails gem page]
B -->|npm| D[react-on-rails npm page]
B -->|npm| E[react-on-rails-pro npm page]
B -->|npm| F[react-on-rails-pro-node-renderer npm page]
C -->|homepage / documentation_uri| G[reactonrails.com/docs/]
D -->|homepage| G
E -->|homepage| H[reactonrails.com/docs/pro/]
F -->|homepage| I[reactonrails.com/docs/pro/node-renderer/]
C -->|post_install_message| J[CTA: OSS vs Pro comparison]
J --> K[Pro quick start]
G --> L[OSS README: Need More Than OSS? section]
H --> M[Pro README: Upgrade from OSS to Pro link]
Reviews (1): Last reviewed commit: "Improve package metadata for Pro discove..." | Re-trigger Greptile |
Review SummaryThe overall direction is good — consolidating on Substantive homepage_uri is redundant in both gemspecs — when s.metadata["homepage_uri"] is set to the same value as s.homepage, one of the two should be dropped. RubyGems will fall back to s.homepage automatically. See inline comments on each gemspec. Unverified URL for node-renderer homepage — https://reactonrails.com/docs/pro/node-renderer/ is new. If that docs page does not exist yet the npm package page will show a dead link (unlike the old GitHub tree URL, which is always live). Please confirm before merging. Personal email in post-install message — embedding [email protected] in a message shown to every bundle install run is a spam-magnet over time. A contact/sales page URL is easier to update and less invasive. Style / Consistency Metadata style mismatch between gemspecs — the OSS gemspec was refactored to a single s.metadata = { ... } block, but the Pro gemspec still uses individual s.metadata["key"] = "value" assignments. These will diverge over time; aligning them now is low-effort (suggested replacement in the inline comment). Out-of-scope dependency reordering — alphabetising async / http-2 / httpx in the Pro gemspec is harmless but inflates the diff for a metadata-only PR. Worth a single-line mention in the PR description so reviewers know no functional change is hiding in the reorder. |
size-limit report 📦
|
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Review Comments AddressedFixed (1):
Verified (1):
Declined with rationale (4):
All 6 review threads resolved. |
Code Review: Improve package metadata and Pro upgrade CTAsThis is a well-contained, low-risk PR. All changes are metadata fields, README additions, and a post-install message rewrite — no runtime code is modified. Good
One new issue
The Previously-raised items (declined by author)
Verdict: One real issue to fix (Pro README email), then ready to merge. |
Address-review summaryScan scope: full history (no prior summary comment found). Mattered
Skipped
Next default scan starts after this comment. Say |
|
Regarding the personal email in Filed as #3118 to keep this PR focused on metadata changes. The fix will replace the personal email with a link to Rationale for skipped items (all previously resolved by author):
|
### Summary Improve RubyGems and npm package discovery so React on Rails users land on the docs site and get a clearer, low-noise path to evaluate Pro. This updates the OSS gem post-install message, points gem and npm homepage/documentation metadata at `reactonrails.com`, and adds concise README upgrade/trial links for the OSS and Pro npm packages. It also adds package `repository.directory` metadata so npm package pages resolve to the right folder in the monorepo. ### Pull Request checklist ~~- [ ] Add/update test to cover these changes~~ - [x] Update documentation ~~- [ ] Update CHANGELOG file~~ ### Other Information Validation included local RubyGems/npm install-message experiments, `package.json` parsing, gemspec loading, and Prettier; RuboCop on the gemspecs still reports the repo's existing `Gemspec/DevelopmentDependencies` offenses. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to package/gem metadata, README links, and a post-install message, with no runtime logic impact aside from updated gem dependencies ordering/metadata fields. > > **Overview** > Updates npm packages (`react-on-rails`, `react-on-rails-pro`, and `react-on-rails-pro-node-renderer`) to improve discoverability by adding `repository.directory` metadata and pointing `homepage` links to `reactonrails.com` docs. > > Refreshes documentation/CTAs: adds an OSS README section promoting Pro with evaluation/licensing links, updates the Pro README to use the docs site and include upgrade/trial messaging, and enhances both gemspecs with richer RubyGems metadata plus an updated `react_on_rails` post-install message directing users to Pro resources. (Also reorders/adds Pro gem runtime dependency entries without changing versions.) > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit be7227c. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated documentation links across packages to point to the new documentation portal. * Added licensing clarification: React on Rails Pro is free for evaluation in development, CI/CD, and staging environments; paid licensing required only for production deployments. * Enhanced README with information about React on Rails Pro features and OSS vs. Pro comparison. * **Chores** * Updated package and gem metadata to include directory references and point to the new documentation domain. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
Improve RubyGems and npm package discovery so React on Rails users land on the docs site and get a clearer, low-noise path to evaluate Pro. This updates the OSS gem post-install message, points gem and npm homepage/documentation metadata at `reactonrails.com`, and adds concise README upgrade/trial links for the OSS and Pro npm packages. It also adds package `repository.directory` metadata so npm package pages resolve to the right folder in the monorepo. ~~- [ ] Add/update test to cover these changes~~ - [x] Update documentation ~~- [ ] Update CHANGELOG file~~ Validation included local RubyGems/npm install-message experiments, `package.json` parsing, gemspec loading, and Prettier; RuboCop on the gemspecs still reports the repo's existing `Gemspec/DevelopmentDependencies` offenses. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to package/gem metadata, README links, and a post-install message, with no runtime logic impact aside from updated gem dependencies ordering/metadata fields. > > **Overview** > Updates npm packages (`react-on-rails`, `react-on-rails-pro`, and `react-on-rails-pro-node-renderer`) to improve discoverability by adding `repository.directory` metadata and pointing `homepage` links to `reactonrails.com` docs. > > Refreshes documentation/CTAs: adds an OSS README section promoting Pro with evaluation/licensing links, updates the Pro README to use the docs site and include upgrade/trial messaging, and enhances both gemspecs with richer RubyGems metadata plus an updated `react_on_rails` post-install message directing users to Pro resources. (Also reorders/adds Pro gem runtime dependency entries without changing versions.) > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit be7227c. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> * **Documentation** * Updated documentation links across packages to point to the new documentation portal. * Added licensing clarification: React on Rails Pro is free for evaluation in development, CI/CD, and staging environments; paid licensing required only for production deployments. * Enhanced README with information about React on Rails Pro features and OSS vs. Pro comparison. * **Chores** * Updated package and gem metadata to include directory references and point to the new documentation domain. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
### Summary Improve RubyGems and npm package discovery so React on Rails users land on the docs site and get a clearer, low-noise path to evaluate Pro. This updates the OSS gem post-install message, points gem and npm homepage/documentation metadata at `reactonrails.com`, and adds concise README upgrade/trial links for the OSS and Pro npm packages. It also adds package `repository.directory` metadata so npm package pages resolve to the right folder in the monorepo. ### Pull Request checklist ~~- [ ] Add/update test to cover these changes~~ - [x] Update documentation ~~- [ ] Update CHANGELOG file~~ ### Other Information Validation included local RubyGems/npm install-message experiments, `package.json` parsing, gemspec loading, and Prettier; RuboCop on the gemspecs still reports the repo's existing `Gemspec/DevelopmentDependencies` offenses. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: changes are limited to package/gem metadata, README links, and a post-install message, with no runtime logic impact aside from updated gem dependencies ordering/metadata fields. > > **Overview** > Updates npm packages (`react-on-rails`, `react-on-rails-pro`, and `react-on-rails-pro-node-renderer`) to improve discoverability by adding `repository.directory` metadata and pointing `homepage` links to `reactonrails.com` docs. > > Refreshes documentation/CTAs: adds an OSS README section promoting Pro with evaluation/licensing links, updates the Pro README to use the docs site and include upgrade/trial messaging, and enhances both gemspecs with richer RubyGems metadata plus an updated `react_on_rails` post-install message directing users to Pro resources. (Also reorders/adds Pro gem runtime dependency entries without changing versions.) > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit be7227c. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated documentation links across packages to point to the new documentation portal. * Added licensing clarification: React on Rails Pro is free for evaluation in development, CI/CD, and staging environments; paid licensing required only for production deployments. * Enhanced README with information about React on Rails Pro features and OSS vs. Pro comparison. * **Chores** * Updated package and gem metadata to include directory references and point to the new documentation domain. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
…ages * origin/main: (44 commits) Consolidate CSP nonce sanitization into shared module (#2828) Add comprehensive --rsc-pro generator tests (#3098) fix: cross-env validation and docs for renderer password (#3090) Improve package metadata and Pro upgrade CTAs (#3112) docs: standardize warning syntax to GFM alert format (#3115) docs: improve react-intl documentation for React Server Components (#3085) Fix generator CI SSR regression on main (#3110) Refocus GitHub README on docs navigation (#3113) Add manual dev environment testing checklist for coding agents (#3074) Bump version to 16.6.0 Update CHANGELOG.md for 16.6.0 (#3078) fix: node-renderer diagnostic improvements (#3086) fix: pin third-party npm deps in generator to prevent peer dep conflicts (#3083) chore(deps): bump lodash from 4.17.23 to 4.18.1 in the npm-security group across 1 directory (#2920) fix: refactor formatExceptionMessage to accept generic request context (#2877) Bump version to 16.6.0.rc.1 Update CHANGELOG.md for 16.6.0.rc.1 (#3079) Update CHANGELOG.md unreleased section (#3077) Fix Content-Length mismatch and null renderingRequest errors in node renderer (#3069) Improve memory debugging docs with simpler heap snapshot approach (#3072) ... # Conflicts: # docs/pro/home-pro.md # docs/pro/react-on-rails-pro.md # docs/sidebars.ts
Summary
Improve RubyGems and npm package discovery so React on Rails users land on the docs site and get a clearer, low-noise path to evaluate Pro. This updates the OSS gem post-install message, points gem and npm homepage/documentation metadata at
reactonrails.com, and adds concise README upgrade/trial links for the OSS and Pro npm packages. It also adds packagerepository.directorymetadata so npm package pages resolve to the right folder in the monorepo.Pull Request checklist
- [ ] Add/update test to cover these changes- [ ] Update CHANGELOG fileOther Information
Validation included local RubyGems/npm install-message experiments,
package.jsonparsing, gemspec loading, and Prettier; RuboCop on the gemspecs still reports the repo's existingGemspec/DevelopmentDependenciesoffenses.Note
Low Risk
Low risk: changes are limited to package/gem metadata, README links, and a post-install message, with no runtime logic impact aside from updated gem dependencies ordering/metadata fields.
Overview
Updates npm packages (
react-on-rails,react-on-rails-pro, andreact-on-rails-pro-node-renderer) to improve discoverability by addingrepository.directorymetadata and pointinghomepagelinks toreactonrails.comdocs.Refreshes documentation/CTAs: adds an OSS README section promoting Pro with evaluation/licensing links, updates the Pro README to use the docs site and include upgrade/trial messaging, and enhances both gemspecs with richer RubyGems metadata plus an updated
react_on_railspost-install message directing users to Pro resources. (Also reorders/adds Pro gem runtime dependency entries without changing versions.)Reviewed by Cursor Bugbot for commit be7227c. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
Documentation
Chores