Skip to content

Update Pro docs URL to canonical /docs/pro path#2657

Merged
justin808 merged 4 commits intomasterfrom
jg/fix-pro-docs-urls
Mar 17, 2026
Merged

Update Pro docs URL to canonical /docs/pro path#2657
justin808 merged 4 commits intomasterfrom
jg/fix-pro-docs-urls

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Mar 17, 2026

Summary

Clean URL separation: /pro for Pro Plans, /docs/pro for Pro Docs.

Test plan

  • Verify reactonrails.com/docs/pro resolves correctly after reactonrails.com#20 is merged

🤖 Generated with Claude Code


Note

Low Risk
Primarily replaces documentation URLs in markdown and user-facing CLI/generator messages; no functional behavior changes beyond link text, so impact is limited to documentation/discoverability.

Overview
Updates documentation and Pro links across the repo to use the canonical reactonrails.com domain (including pro.reactonrails.com) and the /docs/pro landing path.

Also refreshes user-facing help/output strings (CLI success messages, generator/doctor/troubleshooting guidance, and related specs) to point at the new docs URLs, and adds a small docs navigation link row near the top of README.md.

Written by Cursor Bugbot for commit 840c03c. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation

    • Updated Pro trial and documentation URLs across README, changelog, guides, help messages, and user-facing strings to use the reactonrails.com domain.
    • Standardized Pro feature presentation (many lines converted to blockquote/consistent formatting) for clearer docs.
  • Tests

    • Updated test strings to reflect corrected documentation links.

Aligns with shakacode/reactonrails.com#20 which sets /docs/pro as the
canonical Pro docs landing page instead of /docs/pro/react-on-rails-pro/.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 17, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b2a7ced-61bf-4d4d-af0e-9550f5220568

📥 Commits

Reviewing files that changed from the base of the PR and between d4eb733 and 840c03c.

📒 Files selected for processing (1)
  • README.md

Walkthrough

Updated many documentation and user-facing message URLs from shakacode.com to reactonrails.com (including pro.reactonrails.com and shortened docs paths) and standardized several Pro notice lines to blockquote formatting; one constant value was updated. No functional or control-flow changes.

Changes

Cohort / File(s) Summary
Top-level repo docs
react_on_rails_pro/CONTRIBUTING.md, CHANGELOG.md, README.md
Replaced/standardized Pro/trial and docs URLs to pro.reactonrails.com or shortened docs path https://reactonrails.com/docs/pro and added a centered docs/quick-start block in README.
OSS & Pro docs (single-file updates)
docs/oss/api-reference/ruby-api-pro.md, docs/oss/configuration/configuration-pro.md, docs/pro/upgrading-to-pro.md
Updated Pro links to pro.reactonrails.com / reactonrails.com and reformatted Pro notice lines to blockquotes in multiple files.
Building-features docs
docs/oss/building-features/... (e.g., bundle-caching.md, caching.md, code-splitting.md, streaming-server-rendering.md)
Switched Pro feature links to new domain; streaming doc removed an OSS-specific phrase; minor markdown reformatting to blockquote for Pro lines.
Node renderer docs
docs/oss/building-features/node-renderer/... (e.g., basics.md, debugging.md, error-reporting-and-tracing.md, heroku.md, js-configuration.md, troubleshooting.md)
Converted Pro feature lines to blockquotes and updated links to pro.reactonrails.com.
Package CLI & templates
packages/create-react-on-rails-app/src/create-app.ts, packages/create-react-on-rails-app/src/index.ts, packages/react-on-rails/README.md
Updated displayed help/success docs URLs from shakacode.com to reactonrails.com.
Ruby generators & templates
react_on_rails/lib/generators/react_on_rails/generator_messages.rb, react_on_rails/lib/generators/.../templates/base/base/bin/dev
Updated docs URLs in post-install/help messages and comments to reactonrails.com.
Runtime/library messages
react_on_rails/lib/react_on_rails/configuration.rb, react_on_rails/lib/react_on_rails/dev/server_manager.rb, react_on_rails/lib/react_on_rails/doctor.rb, react_on_rails/lib/react_on_rails/packer_utils.rb, react_on_rails/lib/react_on_rails/packs_generator.rb, react_on_rails/lib/react_on_rails/server_rendering_js_code.rb
Replaced user-facing documentation/error/help links with reactonrails.com; strings only, no logic changes.
Rake/tasks & tests
react_on_rails/lib/tasks/generate_packs.rake, react_on_rails/spec/dummy/spec/packs_generator_spec.rb
Updated warning/help URLs and corresponding test expectations to new domain.
Pro gem constant
react_on_rails_pro/lib/react_on_rails_pro/compression_middleware_guard.rb
Changed COMPATIBILITY_GUIDE_PATH constant to point at the reactonrails.com docs URL (domain updated).
Internal/aux docs
AGENTS.md, analysis/create-react-on-rails-app-proposal.md, internal/planning/docs-improvement/04-ia-redesign-plan.md, llms.txt
Normalized table formatting and updated docs links from shakacode.com to reactonrails.com; small wording/URL tweaks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • AbanoubGhadban

Poem

🐰 I hopped through links both old and new,

I nudged each URL to a clearer view,
Blockquotes lined up like neat little rows,
A carrot for docs where the green grass grows. 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 21.05% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main objective of updating Pro docs URLs to the canonical /docs/pro path, which is the primary focus mentioned in the PR objectives.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg/fix-pro-docs-urls
📝 Coding Plan
  • Generate coding plan for human review comments

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 17, 2026

Review

This is a clean, minimal documentation change — updating a single external URL from /docs/pro/react-on-rails-pro/ to the new canonical /docs/pro path.

Code quality / correctness: No issues. The change is scoped to one line in a Markdown file with no runtime impact.

One consideration: The test plan notes that reactonrails.com/docs/pro should be verified after shakacode/reactonrails.com#20 is merged. Until that companion PR is merged and deployed, this link will be broken for anyone following it. This is a minor sequencing concern — it would be slightly safer to merge this PR only after the reactonrails.com side is live, or to note that dependency more explicitly in the PR description.

Otherwise, LGTM. ✅

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Mar 17, 2026

Greptile Summary

This is a minimal documentation-only PR that updates a single hyperlink in react_on_rails_pro/CONTRIBUTING.md, changing the React on Rails Pro docs URL from https://reactonrails.com/docs/pro/react-on-rails-pro/ to the new canonical landing page https://reactonrails.com/docs/pro. This aligns with a companion change in the reactonrails.com repository (shakacode/reactonrails.com#20) which establishes the cleaner /docs/pro path as the authoritative Pro documentation entry point, separating it from the /pro path used for Pro plan/pricing pages.

  • Changed: One URL in react_on_rails_pro/CONTRIBUTING.md line 49, from /docs/pro/react-on-rails-pro//docs/pro
  • No code changes: This PR touches only a Markdown documentation file; no logic, tests, or configuration is affected
  • Dependency: The new URL (reactonrails.com/docs/pro) will only resolve correctly after Set /docs/pro as canonical Pro docs landing page reactonrails.com#20 is merged; the test plan checkbox correctly notes this dependency

Confidence Score: 5/5

  • This PR is safe to merge — it is a single-line documentation URL update with no code, logic, or configuration changes.
  • The change is confined to one line in a Markdown file, updating a hyperlink to its new canonical form. There are no functional, security, or correctness risks. The only soft dependency is that the target URL resolves after the companion reactonrails.com PR is merged, which is already acknowledged in the test plan.
  • No files require special attention.

Important Files Changed

Filename Overview
react_on_rails_pro/CONTRIBUTING.md Single-line documentation update changing the Pro docs URL from /docs/pro/react-on-rails-pro/ to the canonical /docs/pro landing page; no logic or code changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[reactonrails.com] --> B["fa:fa-tag /pro - Pro Plans and Pricing"]
    A --> C["fa:fa-book /docs/pro - Pro Docs Landing Page (canonical)"]
    C --> D["/docs/pro/installation - Installation Guide"]
    C --> E["/docs/pro/react-on-rails-pro - Old path (deprecated)"]
    style C fill:#2d8a4e,color:#fff
    style E fill:#b0b0b0,color:#333
Loading

Last reviewed commit: 5ef4d1c

- Fix pro.reactrails.com → pro.reactonrails.com across 14 files
- Update old shakacode.com/react-on-rails/docs/pro URL to reactonrails.com/docs/pro

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 17, 2026

Review: Documentation URL Updates

This is a clean, low-risk documentation-only PR. Changes look correct and consistent.

What's being fixed:

  1. Domain typo correction: pro.reactrails.com -> pro.reactonrails.com (missing "on" in the old domain) — applied consistently across all 13 affected files.
  2. Canonical path simplification: /docs/pro/react-on-rails-pro/ -> /docs/pro in CONTRIBUTING.md.
  3. CHANGELOG link migration: Old shakacode.com/react-on-rails/docs/... -> reactonrails.com/docs/pro.

Verification:

  • No remaining instances of pro.reactrails.com in the repo (all cleaned up).
  • The one remaining reference to docs/pro/react-on-rails-pro in AGENTS_USER_GUIDE.md (line 113) is a relative local file link (./docs/pro/react-on-rails-pro.md), not a web URL — that file still exists, so it's valid and unrelated to these changes.

Minor note: The PR title only mentions the canonical /docs/pro path update, but the bulk of the changes are actually the domain typo fix (reactrails -> reactonrails). Consider a broader title like "Fix Pro domain URL typo and update canonical docs path" for better changelog clarity — though this is purely cosmetic.

The test plan item (verifying reactonrails.com/docs/pro resolves after the dependent PR merges) is the right gate before merging. LGTM otherwise.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Line 1669: This PR only updates documentation links but also alters
CHANGELOG.md entry "Support for Node.js server side rendering. See
[`#380`](https://github.com/shakacode/react_on_rails/pull/380)..." — revert/remove
that CHANGELOG.md change so the release history remains unchanged for doc-only
edits; keep your docs-link cleanup confined to documentation files (e.g., the
doc page that you edited) and do not include changelog edits for
non-user-visible doc fixes, then amend the commit to remove the CHANGELOG.md
modification before merging.
🪄 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: af56c230-5695-44aa-add9-83e2b9dfcd34

📥 Commits

Reviewing files that changed from the base of the PR and between 5ef4d1c and a0b4056.

📒 Files selected for processing (15)
  • CHANGELOG.md
  • README.md
  • docs/oss/api-reference/ruby-api-pro.md
  • docs/oss/building-features/bundle-caching.md
  • docs/oss/building-features/caching.md
  • docs/oss/building-features/code-splitting.md
  • docs/oss/building-features/node-renderer/basics.md
  • docs/oss/building-features/node-renderer/debugging.md
  • docs/oss/building-features/node-renderer/error-reporting-and-tracing.md
  • docs/oss/building-features/node-renderer/heroku.md
  • docs/oss/building-features/node-renderer/js-configuration.md
  • docs/oss/building-features/node-renderer/troubleshooting.md
  • docs/oss/building-features/streaming-server-rendering.md
  • docs/oss/configuration/configuration-pro.md
  • docs/pro/upgrading-to-pro.md
✅ Files skipped from review due to trivial changes (5)
  • docs/oss/building-features/bundle-caching.md
  • docs/pro/upgrading-to-pro.md
  • docs/oss/configuration/configuration-pro.md
  • docs/oss/building-features/code-splitting.md
  • docs/oss/building-features/streaming-server-rendering.md

Comment thread CHANGELOG.md

- Support for React 15.0 to react_on_rails. See [#379](https://github.com/shakacode/react_on_rails/pull/379) by [brucek](https://github.com/brucek).
- Support for Node.js server side rendering. See [#380](https://github.com/shakacode/react_on_rails/pull/380) by [alleycat](https://github.com/alleycat-at-git) and [doc](https://www.shakacode.com/react-on-rails/docs/pro/react-on-rails-pro#pro-integration-with-nodejs-for-server-rendering)
- Support for Node.js server side rendering. See [#380](https://github.com/shakacode/react_on_rails/pull/380) by [alleycat](https://github.com/alleycat-at-git) and [doc](https://reactonrails.com/docs/pro#pro-integration-with-nodejs-for-server-rendering)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Avoid doc-only edits in CHANGELOG.md.

Line 1669 updates documentation linkage inside historical release notes; this PR is a docs-link cleanup, so this changelog edit should be avoided to keep release history scoped to product changes.

As per coding guidelines, "Update /CHANGELOG.md only for user-visible changes (features, bug fixes, breaking changes, deprecations, performance improvements) — do NOT add entries for linting, formatting, refactoring, tests, or doc fixes".

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` at line 1669, This PR only updates documentation links but also
alters CHANGELOG.md entry "Support for Node.js server side rendering. See
[`#380`](https://github.com/shakacode/react_on_rails/pull/380)..." — revert/remove
that CHANGELOG.md change so the release history remains unchanged for doc-only
edits; keep your docs-link cleanup confined to documentation files (e.g., the
doc page that you edited) and do not include changelog edits for
non-user-visible doc fixes, then amend the commit to remove the CHANGELOG.md
modification before merging.

Migrates all docs URLs from the old www.shakacode.com/react-on-rails/docs
domain to the canonical reactonrails.com/docs across 19 files including
source code, templates, specs, changelogs, and docs.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@coderabbitai coderabbitai Bot added documentation docs-cleanup Documentation cleanup or migration P3 Parked priority labels Mar 17, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 17, 2026

size-limit report 📦

Path Size
react-on-rails/client bundled (gzip) 62.63 KB (0%)
react-on-rails/client bundled (gzip) (time) 62.63 KB (0%)
react-on-rails/client bundled (brotli) 53.74 KB (0%)
react-on-rails/client bundled (brotli) (time) 53.74 KB (0%)
react-on-rails-pro/client bundled (gzip) 63.65 KB (0%)
react-on-rails-pro/client bundled (gzip) (time) 63.65 KB (0%)
react-on-rails-pro/client bundled (brotli) 54.68 KB (0%)
react-on-rails-pro/client bundled (brotli) (time) 54.68 KB (0%)
registerServerComponent/client bundled (gzip) 127.46 KB (0%)
registerServerComponent/client bundled (gzip) (time) 127.46 KB (0%)
registerServerComponent/client bundled (brotli) 61.64 KB (0%)
registerServerComponent/client bundled (brotli) (time) 61.64 KB (0%)
wrapServerComponentRenderer/client bundled (gzip) 122.02 KB (0%)
wrapServerComponentRenderer/client bundled (gzip) (time) 122.02 KB (0%)
wrapServerComponentRenderer/client bundled (brotli) 56.77 KB (0%)
wrapServerComponentRenderer/client bundled (brotli) (time) 56.77 KB (0%)

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
llms.txt (1)

104-110: ⚠️ Potential issue | 🟡 Minor

Update remaining Pro links in this section to the canonical domain.

Line 104 is updated, but Lines 105–110 still point to legacy www.shakacode.com Pro docs URLs. That leaves this single section inconsistent.

Suggested patch
 - Pro Docs: https://www.shakacode.com/react-on-rails-pro/docs/
 - Pro Installation: https://www.shakacode.com/react-on-rails-pro/docs/installation/
 - Pro Configuration: https://www.shakacode.com/react-on-rails-pro/docs/configuration/
 - Node Renderer Basics: https://www.shakacode.com/react-on-rails-pro/docs/node-renderer/basics/
 - Node Renderer JS Config: https://www.shakacode.com/react-on-rails-pro/docs/node-renderer/js-configuration/
 - RSC Tutorial: https://www.shakacode.com/react-on-rails-pro/docs/react-server-components/tutorial/
+ Pro Docs: https://reactonrails.com/docs/pro/
+ Pro Installation: https://reactonrails.com/docs/pro/installation/
+ Pro Configuration: https://reactonrails.com/docs/pro/configuration/
+ Node Renderer Basics: https://reactonrails.com/docs/pro/node-renderer/basics/
+ Node Renderer JS Config: https://reactonrails.com/docs/pro/node-renderer/js-configuration/
+ RSC Tutorial: https://reactonrails.com/docs/pro/react-server-components/tutorial/
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@llms.txt` around lines 104 - 110, Update the remaining Pro docs links in this
section to use the canonical reactonrails.com domain instead of the legacy
www.shakacode.com domain: change
"https://www.shakacode.com/react-on-rails-pro/docs/" to
"https://reactonrails.com/pro/docs/",
"https://www.shakacode.com/react-on-rails-pro/docs/installation/" to
"https://reactonrails.com/pro/docs/installation/",
"https://www.shakacode.com/react-on-rails-pro/docs/configuration/" to
"https://reactonrails.com/pro/docs/configuration/",
"https://www.shakacode.com/react-on-rails-pro/docs/node-renderer/basics/" to
"https://reactonrails.com/pro/docs/node-renderer/basics/",
"https://www.shakacode.com/react-on-rails-pro/docs/node-renderer/js-configuration/"
to "https://reactonrails.com/pro/docs/node-renderer/js-configuration/", and
"https://www.shakacode.com/react-on-rails-pro/docs/react-server-components/tutorial/"
to "https://reactonrails.com/pro/docs/react-server-components/tutorial/" so the
whole Pro section is consistent.
🧹 Nitpick comments (1)
react_on_rails/lib/react_on_rails/packs_generator.rb (1)

583-607: Optional: deduplicate the repeated docs URL.

The same long URL now appears in multiple raise helpers; extracting a constant would reduce drift risk on future link migrations.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@react_on_rails/lib/react_on_rails/packs_generator.rb` around lines 583 - 607,
The three error helpers raise_client_component_overrides_common,
raise_server_component_overrides_common, and raise_missing_client_component
duplicate the long docs URL; extract that URL into a single constant (e.g.,
FILE_SYSTEM_AUTOMATED_BUNDLE_GUIDE_URL or DOCS_URL) at the top of the class or
module and interpolate that constant into each message string so all three
methods reference the same constant instead of repeating the literal URL.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@llms.txt`:
- Around line 104-110: Update the remaining Pro docs links in this section to
use the canonical reactonrails.com domain instead of the legacy
www.shakacode.com domain: change
"https://www.shakacode.com/react-on-rails-pro/docs/" to
"https://reactonrails.com/pro/docs/",
"https://www.shakacode.com/react-on-rails-pro/docs/installation/" to
"https://reactonrails.com/pro/docs/installation/",
"https://www.shakacode.com/react-on-rails-pro/docs/configuration/" to
"https://reactonrails.com/pro/docs/configuration/",
"https://www.shakacode.com/react-on-rails-pro/docs/node-renderer/basics/" to
"https://reactonrails.com/pro/docs/node-renderer/basics/",
"https://www.shakacode.com/react-on-rails-pro/docs/node-renderer/js-configuration/"
to "https://reactonrails.com/pro/docs/node-renderer/js-configuration/", and
"https://www.shakacode.com/react-on-rails-pro/docs/react-server-components/tutorial/"
to "https://reactonrails.com/pro/docs/react-server-components/tutorial/" so the
whole Pro section is consistent.

---

Nitpick comments:
In `@react_on_rails/lib/react_on_rails/packs_generator.rb`:
- Around line 583-607: The three error helpers
raise_client_component_overrides_common,
raise_server_component_overrides_common, and raise_missing_client_component
duplicate the long docs URL; extract that URL into a single constant (e.g.,
FILE_SYSTEM_AUTOMATED_BUNDLE_GUIDE_URL or DOCS_URL) at the top of the class or
module and interpolate that constant into each message string so all three
methods reference the same constant instead of repeating the literal URL.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 088bd83a-c725-41cf-8d08-5c217edb031d

📥 Commits

Reviewing files that changed from the base of the PR and between a0b4056 and d4eb733.

📒 Files selected for processing (19)
  • AGENTS.md
  • CHANGELOG.md
  • analysis/create-react-on-rails-app-proposal.md
  • internal/planning/docs-improvement/04-ia-redesign-plan.md
  • llms.txt
  • packages/create-react-on-rails-app/src/create-app.ts
  • packages/create-react-on-rails-app/src/index.ts
  • packages/react-on-rails/README.md
  • react_on_rails/lib/generators/react_on_rails/generator_messages.rb
  • react_on_rails/lib/generators/react_on_rails/templates/base/base/bin/dev
  • react_on_rails/lib/react_on_rails/configuration.rb
  • react_on_rails/lib/react_on_rails/dev/server_manager.rb
  • react_on_rails/lib/react_on_rails/doctor.rb
  • react_on_rails/lib/react_on_rails/packer_utils.rb
  • react_on_rails/lib/react_on_rails/packs_generator.rb
  • react_on_rails/lib/react_on_rails/server_rendering_js_code.rb
  • react_on_rails/lib/tasks/generate_packs.rake
  • react_on_rails/spec/dummy/spec/packs_generator_spec.rb
  • react_on_rails_pro/lib/react_on_rails_pro/compression_middleware_guard.rb
✅ Files skipped from review due to trivial changes (7)
  • analysis/create-react-on-rails-app-proposal.md
  • internal/planning/docs-improvement/04-ia-redesign-plan.md
  • react_on_rails/lib/generators/react_on_rails/templates/base/base/bin/dev
  • react_on_rails/lib/react_on_rails/packer_utils.rb
  • packages/create-react-on-rails-app/src/index.ts
  • react_on_rails/lib/react_on_rails/configuration.rb
  • react_on_rails/lib/react_on_rails/dev/server_manager.rb

Comment thread llms.txt

- Docs: https://www.shakacode.com/react-on-rails/docs/
- Docs: https://reactonrails.com/docs/
- Pro Docs: https://www.shakacode.com/react-on-rails-pro/docs/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These Pro docs links (lines 105–110) were not updated while the adjacent OSS docs link on line 104 was. If shakacode.com/react-on-rails-pro/docs/ is also a stale domain, all six should be updated here for consistency — likely to reactonrails.com/docs/pro/... paths. If they intentionally point to a different location, a brief inline note would help clarify that.

Suggested change
- Pro Docs: https://www.shakacode.com/react-on-rails-pro/docs/
- Pro Docs: https://reactonrails.com/docs/pro

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 17, 2026

Review notes for PR 2657 - URL updates are correct and complete for the files touched. Three observations: (1) llms.txt is a partial fix - line 104 OSS docs link was updated but lines 105-110 still use shakacode.com/react-on-rails-pro/docs/ pattern; inline comment posted. (2) ~47 files in the repo still have old URLs, so this is a phased cleanup. (3) The CONTRIBUTING.md change depends on reactonrails.com PR 20 being live before merge. Otherwise LGTM.

@justin808
Copy link
Copy Markdown
Member Author

@cursor review

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Add a centered documentation navigation line to the README after the CI
badges, linking to the canonical docs site at reactonrails.com.

Links: Documentation, Quick Start, Examples, and Pro.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
@justin808 justin808 merged commit 75a66d4 into master Mar 17, 2026
20 of 21 checks passed
@justin808 justin808 deleted the jg/fix-pro-docs-urls branch March 17, 2026 22:09
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Mar 17, 2026

Overall this is a clean, low-risk PR with no behavioral changes. The test spec updates correctly mirror the production error messages. Two items worth checking before merge.

1. Stale link text in AGENTS.md — Line 97 still reads 'ShakaCode website' but now points to reactonrails.com. The link text should be updated to match the new domain.

2. .md extensions in error message URLs — Several Ruby error messages reference URLs with a trailing .md extension, e.g. https://reactonrails.com/docs/guides/file-system-based-automated-bundle-generation.md (in configuration.rb, packer_utils.rb, packs_generator.rb, generate_packs.rake). Most doc sites serve HTML at paths without a file extension. If reactonrails.com does not route .md paths, these in-app error links will 404 for users. Worth verifying or dropping the .md suffix.

Everything else looks correct — typo fix (pro.reactrails.com to pro.reactonrails.com), CONTRIBUTING.md canonical path update, and the new README nav bar are all good.

Comment thread AGENTS.md
| `packages/react-on-rails/tests/` | Jest tests for the npm package |
| `react_on_rails_pro/` | Pro package (separate gem + npm, own lint config) |
| `rakelib/` | Rake task definitions |
| `docs/oss/` | OSS documentation — published to the [ShakaCode website](https://reactonrails.com/docs/) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link text still says "ShakaCode website" but now points to reactonrails.com. Consider updating the anchor text to match the new domain.

Suggested change
| `docs/oss/` | OSS documentation — published to the [ShakaCode website](https://reactonrails.com/docs/) |
| `docs/oss/` | OSS documentation — published to the [reactonrails.com](https://reactonrails.com/docs/) |

**ERROR** ReactOnRails: client specific definition for Component '#{component_name}' overrides the \
common definition. Please delete the common definition and have separate server and client files. For more \
information, please see https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md
information, please see https://reactonrails.com/docs/guides/file-system-based-automated-bundle-generation.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This URL carries a .md extension that was present on the old domain. The new reactonrails.com site likely serves docs at paths without a file extension. If this path isn't explicitly routed, users following the link from an error message will hit a 404. Please verify the URL resolves, and if not, drop the .md suffix (same applies to the two other error messages in this file and the equivalent URLs in configuration.rb, packer_utils.rb, and generate_packs.rake).

justin808 added a commit that referenced this pull request Mar 25, 2026
## Summary

- Stamp `### [16.5.0.rc.0]` version header with today's date
- Add 10 new changelog entries for PRs merged since v16.4.0
- Fix incomplete PR 2818 entry (missing author link)

### New entries added

**Added:**
- `create-react-on-rails-app --pro` support (PR 2818)
- Global prerender env override `REACT_ON_RAILS_PRERENDER_OVERRIDE` (PR
2816)
- `react_on_rails:sync_versions` rake task (PR 2797)
- Pro/RSC setup checks in `react_on_rails:doctor` (PR 2674)

**Changed:**
- [Pro] Canonical env var for worker count is now
`RENDERER_WORKERS_COUNT` (PR 2611)

**Improved:**
- Smoother `create-react-on-rails-app` and install generator flows (PR
2650)
- Pro upgrade hint after install (PR 2642)

**Fixed:**
- Preserve runtime env vars across `Bundler.with_unbundled_env` (PR
2836)
- Fix doctor prerender check and ExecJS display for Pro/RSC apps (PR
2773)
- Fix doctor false positives for custom layouts (PR 2612)

### Skipped PRs (not user-visible)

Docs-only: #2845, #2842, #2826, #2830, #2820, #2809, #2803, #2785,
#2801, #2791, #2789, #2788, #2772, #2778, #2780, #2784, #2671, #2676,
#2662, #2657, #2669
CI/internal tooling: #2825, #2817, #2819, #2812, #2815, #2810, #2808,
#2807, #2634, #2798, #2761, #2760, #2658, #2639, #2667, #2656

## Test plan

- [x] Verified version header and diff links are correct
- [x] Verified all entries follow changelog formatting conventions
- [x] Verified file ends with newline
- [ ] After merge, run `rake release` to publish 16.5.0.rc.0

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Documentation-only change updating `CHANGELOG.md` with a new
`16.5.0.rc.0` section and compare links; no runtime code is modified.
> 
> **Overview**
> Adds a new `16.5.0.rc.0` (2026-03-25) section to `CHANGELOG.md`,
consolidating recent PR entries under **Added/Changed/Improved/Fixed**
and correcting the previously incomplete `--pro` CLI entry author
attribution.
> 
> Updates the bottom compare links so `[unreleased]` now compares from
`v16.5.0.rc.0` and adds a link definition for `[16.5.0.rc.0]`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
481a71c. 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

## Release Notes - v16.5.0.rc.0

* **New Features**
  * Added sync_versions task for streamlined version management
  * Expanded doctor checks for Pro and RSC support

* **Improvements**
  * Enhanced generator workflow and Pro upgrade guidance
  * Improved environment variable handling and preservation

* **Bug Fixes**
* Fixed detection issues with doctor tools and ExecJS/prerender
functionality

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
justin808 added a commit that referenced this pull request Mar 30, 2026
- Updates the Pro docs link in `react_on_rails_pro/CONTRIBUTING.md` from
`/docs/pro/react-on-rails-pro/` to `/docs/pro`
- Aligns with shakacode/reactonrails.com#20 which establishes
`/docs/pro` as the canonical Pro docs landing page

Clean URL separation: `/pro` for Pro Plans, `/docs/pro` for Pro Docs.

- [ ] Verify `reactonrails.com/docs/pro` resolves correctly after
reactonrails.com#20 is merged

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: changes are limited to documentation URLs and user-facing
help/error messages, with no behavioral or API changes.
>
> **Overview**
> Updates documentation links across the repo to use the new canonical
`reactonrails.com` domain/paths, including standardizing Pro references
to `https://reactonrails.com/docs/pro` and updating `pro.reactrails.com`
→ `pro.reactonrails.com`.
>
> Also refreshes various user-facing output (generators, `bin/dev` help,
`doctor`, rake task errors) and related test expectations to point at
the new docs URLs, plus minor formatting cleanup in `AGENTS.md` and
historical links in `CHANGELOG.md`.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
d4eb733. 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
-->

* **Documentation**
* Updated Pro trial and documentation URLs across README, changelog,
guides, and help messages to the reactonrails.com domain.
* Standardized presentation of Pro feature notices (converted several
lines to blockquote/consistent formatting) for clearer, consistent docs.
* Adjusted user-facing messages and test strings to reflect the
corrected documentation links.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
Co-authored-by: Ihab Adham <[email protected]>
justin808 added a commit that referenced this pull request Apr 6, 2026
- Updates the Pro docs link in `react_on_rails_pro/CONTRIBUTING.md` from
`/docs/pro/react-on-rails-pro/` to `/docs/pro`
- Aligns with shakacode/reactonrails.com#20 which establishes
`/docs/pro` as the canonical Pro docs landing page

Clean URL separation: `/pro` for Pro Plans, `/docs/pro` for Pro Docs.

- [ ] Verify `reactonrails.com/docs/pro` resolves correctly after
reactonrails.com#20 is merged

🤖 Generated with [Claude Code](https://claude.com/claude-code)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: changes are limited to documentation URLs and user-facing
help/error messages, with no behavioral or API changes.
>
> **Overview**
> Updates documentation links across the repo to use the new canonical
`reactonrails.com` domain/paths, including standardizing Pro references
to `https://reactonrails.com/docs/pro` and updating `pro.reactrails.com`
→ `pro.reactonrails.com`.
>
> Also refreshes various user-facing output (generators, `bin/dev` help,
`doctor`, rake task errors) and related test expectations to point at
the new docs URLs, plus minor formatting cleanup in `AGENTS.md` and
historical links in `CHANGELOG.md`.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
d4eb733. 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
-->

* **Documentation**
* Updated Pro trial and documentation URLs across README, changelog,
guides, and help messages to the reactonrails.com domain.
* Standardized presentation of Pro feature notices (converted several
lines to blockquote/consistent formatting) for clearer, consistent docs.
* Adjusted user-facing messages and test strings to reflect the
corrected documentation links.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
Co-authored-by: Ihab Adham <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-cleanup Documentation cleanup or migration documentation P3 Parked priority review-needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants