Fix broken links from docs reorganization (file paths and website URLs)#2229
Fix broken links from docs reorganization (file paths and website URLs)#2229
Conversation
Update all links to docs that were reorganized in PR #1845: - docs/release-notes/16.0.0.md → docs/upgrading/release-notes/16.0.0.md - sig/README.md → react_on_rails/sig/README.md - docs/additional-reading/turbolinks.md → docs/building-features/turbolinks.md - docs/guides/i18n.md → docs/building-features/i18n.md - docs/guides/upgrading-react-on-rails.md → docs/upgrading/upgrading-react-on-rails.md - docs/guides/auto-bundling-file-system-based-automated-bundle-generation.md → docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation.md Files updated: - CHANGELOG.md (1 link) - docs/contributor-info/rbs-type-signatures.md (1 link) - NEWS.md (3 links) - README.md (2 links) Verified locally with lychee: all 6 broken doc reorganization links are now fixed. Resolves #2226 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
WalkthroughDocumentation-only updates: numerous markdown files had internal links and paths adjusted to match a reorganized docs structure; no source code, APIs, or behavior were changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
Code Review - PR #2229✅ SummaryThis PR successfully fixes 6 broken internal documentation links that resulted from the docs reorganization in PR #1845. All changes are documentation-only with no code modifications. 🎯 Code Quality: ExcellentStrengths:
📝 Best Practices: Followed✅ Documentation-only changes - No code modifications 🔍 Potential Issues: None Found
💡 Minor Observations
✨ Recommendation: APPROVEThis is a clean, well-executed documentation fix that improves the developer experience by ensuring all internal links work correctly. No issues found. Review generated with Claude Code following project guidelines from CLAUDE.md |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Updates 11 broken shakacode.com URL references in CHANGELOG.md to reflect the docs reorganization from PR #1845. These URLs were returning 404s. URL mappings: - docs/guides/upgrading-react-on-rails → docs/upgrading/upgrading-react-on-rails - docs/guides/configuration → docs/api-reference/configuration - docs/guides/rspec_configuration → docs/building-features/rspec-configuration - docs/rails/turbolinks → docs/building-features/turbolinks - docs/additional-details/migrating-from-react-rails → docs/migrating/migrating-from-react-rails - docs/react-on-rails-pro/react-on-rails-pro → docs/pro/react-on-rails-pro Part of ongoing link cleanup tracked in issue #2232.
ihabadham
changed the title
Code Review: Fix broken links from docs reorganization✅ Overall AssessmentThis is an excellent maintenance PR that fixes broken documentation links. The changes are well-organized, thoroughly tested, and follow best practices. 🎯 Strengths
🐛 Issue Found: One Missed LinkFound one additional broken link that should be fixed in this PR: File: Current (broken): [I18n and localization support](https://www.shakacode.com/react-on-rails/docs/guides/i18n)Should be: [I18n and localization support](https://www.shakacode.com/react-on-rails/docs/building-features/i18n)Location: In the "Why React on Rails?" feature table, the Internationalization row still references the old 📋 Additional Observations
✅ Code Quality
🎯 RecommendationApprove with one minor fix: Please update the one missed link in README.md (the i18n URL in the feature table). Otherwise, this PR is ready to merge. Great work cleaning up these broken links! This will improve the documentation experience significantly. 🚀 |
Found by Claude Code review - we only searched CHANGELOG.md initially, but missed these two in README.md: - docs/guides/i18n → docs/building-features/i18n - docs/guides/rails-webpacker-react-integration-options → docs/building-features/rails-webpacker-react-integration-options Total fixes now: 13 shakacode.com URLs (11 in CHANGELOG + 2 in README)
…api.md Found via comprehensive search across all markdown files. - docs/rails/turbolinks → docs/building-features/turbolinks Total fixes now: 14 shakacode.com URLs (11 CHANGELOG + 2 README + 1 docs)
Code Review - PR #2229: Fix broken links from docs reorganization✅ Overall AssessmentThis is an excellent cleanup PR that addresses broken links from the docs reorganization in PR #1845. The changes are methodical, well-documented, and thoroughly tested. 🎯 Strengths
📝 Technical ReviewFile Changes AnalysisCHANGELOG.md (12 changes)
README.md (15 changes)
NEWS.md (3 changes)
docs/api-reference/javascript-api.md (1 change)
docs/contributor-info/rbs-type-signatures.md (1 change)
🔍 Code Quality
✅ TestingThe PR description indicates verification was done using the lychee link checker, which is appropriate for this type of change. All 17 broken links have been identified and corrected. 💡 Suggestions (Minor)While this PR is ready to merge as-is, here are some optional follow-up considerations:
These are NOT blockers for this PR - just ideas for future improvements. ✨ ConclusionRecommendation: APPROVE and MERGE ✅ This PR:
Great work on the systematic cleanup! This type of maintenance work is valuable for keeping the documentation accessible and professional. Related PRs to watch:
🤖 Generated with Claude Code |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
CHANGELOG.md (3)
5-5: Use descriptive link text instead of "here".The link text should describe the destination rather than using generic terms like "here". Update to something like "upgrading guide for major updates".
-Migration instructions for the major updates can be found [here](https://www.shakacode.com/react-on-rails/docs/upgrading/upgrading-react-on-rails#upgrading-to-version-9). +Migration instructions for the major updates can be found in the [upgrading guide](https://www.shakacode.com/react-on-rails/docs/upgrading/upgrading-react-on-rails#upgrading-to-version-9).
712-712: Update link text to match the new documentation path.The URL has been correctly updated, but the link text still shows the old file path
docs/guides/upgrading-react-on-rails.md. The link text should match the new location or use more descriptive text.-For upgrade instructions, see [docs/guides/upgrading-react-on-rails.md](https://www.shakacode.com/react-on-rails/docs/upgrading/upgrading-react-on-rails). +For upgrade instructions, see [upgrading guide](https://www.shakacode.com/react-on-rails/docs/upgrading/upgrading-react-on-rails).
1521-1521: Use descriptive link text instead of generic "doc".The link text "doc" is too generic and violates markdown best practices. Replace with descriptive text like "Pro Node.js rendering documentation" or similar.
-- 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 [Pro Node.js rendering documentation](https://www.shakacode.com/react-on-rails/docs/pro/react-on-rails-pro#pro-integration-with-nodejs-for-server-rendering)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(10 hunks)README.md(2 hunks)docs/api-reference/javascript-api.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/api-reference/javascript-api.md
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
🧰 Additional context used
📓 Path-based instructions (2)
CHANGELOG.md
📄 CodeRabbit inference engine (CLAUDE.md)
Update
/CHANGELOG.mdfor open-source features, bug fixes, breaking changes, and performance improvements
Files:
CHANGELOG.md
**/*.{js,jsx,ts,tsx,json,css,scss,md}
📄 CodeRabbit inference engine (CLAUDE.md)
Use Prettier as the sole authority for formatting non-Ruby files
Files:
CHANGELOG.md
🧠 Learnings (15)
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to CHANGELOG.md : Update `/CHANGELOG.md` for open-source features, bug fixes, breaking changes, and performance improvements
Applied to files:
CHANGELOG.md
📚 Learning: 2025-04-26T21:55:55.874Z
Learnt from: alexeyr-ci2
Repo: shakacode/react_on_rails PR: 1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-12T16:38:06.537Z
Learnt from: Romex91
Repo: shakacode/react_on_rails PR: 1697
File: package-scripts.yml:28-28
Timestamp: 2025-02-12T16:38:06.537Z
Learning: The file `node_package/lib/ReactOnRails.full.js` is autogenerated during the build process and should not be present in the repository.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to react_on_rails_pro/**/*.{js,ts,jsx,tsx,json,css,scss} : The `react_on_rails_pro/` directory has its own Prettier/ESLint configuration and will be linted separately in CI
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to lib/react_on_rails/**/*.rb : Add RBS type signatures for new Ruby files in `lib/react_on_rails/` by creating corresponding `.rbs` files in `sig/react_on_rails/`
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to lib/react_on_rails/**/*.rb : Validate RBS signatures with `bundle exec rake rbs:validate` and run Steep type checker with `bundle exec rake rbs:steep` for Ruby files
Applied to files:
CHANGELOG.md
📚 Learning: 2025-09-16T08:01:11.146Z
Learnt from: justin808
Repo: shakacode/react_on_rails PR: 1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to packages/react-on-rails/src/**/*.tsx : For React component files, use TypeScript (.tsx extension) and follow the component registry pattern for registration
Applied to files:
CHANGELOG.md
📚 Learning: 2025-09-15T21:24:48.207Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1781
File: node_package/src/ClientSideRenderer.ts:82-95
Timestamp: 2025-09-15T21:24:48.207Z
Learning: In React on Rails, the force_load feature includes both explicit `data-force-load="true"` usage and the ability to hydrate components during the page loading state (`document.readyState === 'loading'`). Both capabilities require a Pro license, so the condition `!railsContext.rorPro && (isComponentForceLoaded || document.readyState === 'loading')` correctly gates both scenarios.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-18T13:08:01.477Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: lib/react_on_rails/helper.rb:190-197
Timestamp: 2025-02-18T13:08:01.477Z
Learning: RSC support validation in React on Rails Pro is handled through a chain of validations:
1. Pro version check in `run_stream_inside_fiber`
2. RSC support check during pack generation via `ReactOnRailsPro.configuration.enable_rsc_support`
3. RSC support validation during component registration
This makes additional validation in the helper methods unnecessary.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-18T13:08:01.477Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: lib/react_on_rails/helper.rb:190-197
Timestamp: 2025-02-18T13:08:01.477Z
Learning: RSC support validation is handled in deeper level calls of the React on Rails Pro codebase, so it doesn't need to be validated again in the `rsc_payload_react_component` helper method.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-13T16:50:47.848Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/clientStartup.ts:18-21
Timestamp: 2025-02-13T16:50:47.848Z
Learning: In the react_on_rails module, the `reactOnRailsPageUnloaded` function in clientStartup.ts is intentionally kept private as it's only used internally as a callback for `onPageUnloaded`.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-13T16:50:26.861Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/turbolinksUtils.ts:34-36
Timestamp: 2025-02-13T16:50:26.861Z
Learning: In React on Rails, when checking for Turbolinks version 5 using `turbolinksVersion5()`, always ensure `Turbolinks` exists first by checking `turbolinksInstalled()` to prevent TypeError when accessing properties.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-07-08T05:57:29.630Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1745
File: node_package/src/RSCRequestTracker.ts:8-14
Timestamp: 2025-07-08T05:57:29.630Z
Learning: The global `generateRSCPayload` function in React on Rails Pro (RORP) is provided by the framework during rendering requests, not implemented in application code. The `declare global` statements are used to document the expected interface that RORP will inject at runtime.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-10-23T17:22:01.074Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1875
File: lib/react_on_rails/utils.rb:112-124
Timestamp: 2025-10-23T17:22:01.074Z
Learning: In React on Rails, when Pro is installed but not licensed, the intended behavior is to raise an error on boot. The `react_on_rails_pro?` method validates licenses and should raise errors early (including during path resolution in methods like `server_bundle?`) to enforce licensing requirements rather than failing later with obscure errors.
Applied to files:
CHANGELOG.md
🪛 markdownlint-cli2 (0.18.1)
CHANGELOG.md
5-5: Link text should be descriptive
(MD059, descriptive-link-text)
1734-1734: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: markdown-link-check
🔇 Additional comments (6)
CHANGELOG.md (6)
291-291: Link path correctly updated.The release notes link path has been correctly updated from the old docs structure to the new upgrading/release-notes location.
676-676: Link path correctly updated.The configuration link has been correctly updated from docs/guides/configuration to the new docs/api-reference/configuration location.
1691-1691: Link path correctly updated.The rspec configuration link has been correctly updated to the new docs/building-features/rspec-configuration location.
1718-1718: Link path correctly updated.The turbolinks documentation link has been correctly updated to the new docs/building-features/turbolinks location.
1729-1729: Link path correctly updated.The turbolinks documentation link has been correctly updated to docs/building-features/turbolinks.
1737-1737: Link path correctly updated.The migration guide link has been correctly updated to the new docs/migrating/migrating-from-react-rails location.
Per CodeRabbit review feedback: link text showed old path 'docs/guides/upgrading-react-on-rails.md' while URL pointed to new location. Updated to use descriptive text 'upgrading guide' instead.
Code Review - PR #2229: Fix broken links from docs reorganization✅ Overall AssessmentThis is an excellent cleanup PR that fixes broken links resulting from the docs reorganization in PR #1845. The changes are purely documentation fixes with no code or functionality changes. 📋 What Was ReviewedChanges Summary:
Files Modified:
✅ Strengths
🔍 Path VerificationI verified all target paths exist:
📝 Observations
🎯 RecommendationsNo blocking issues found. The PR is ready to merge. Optional follow-up (not blocking):
🔐 Security & Performance
🧪 TestingThe PR description states all links were tested:
My verification confirms all new paths exist in the repository. Verdict: ✅ APPROVE - This is a clean, well-documented fix that addresses a real issue with no risks. Ready to merge. 🤖 Review generated with Claude Code |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md(10 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
CHANGELOG.md
📄 CodeRabbit inference engine (CLAUDE.md)
Update
/CHANGELOG.mdfor open-source features, bug fixes, breaking changes, and performance improvements
Files:
CHANGELOG.md
**/*.{js,jsx,ts,tsx,json,css,scss,md}
📄 CodeRabbit inference engine (CLAUDE.md)
Use Prettier as the sole authority for formatting non-Ruby files
Files:
CHANGELOG.md
🧠 Learnings (17)
📓 Common learnings
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to CHANGELOG.md : Update `/CHANGELOG.md` for open-source features, bug fixes, breaking changes, and performance improvements
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to CHANGELOG_PRO.md : Update `/CHANGELOG_PRO.md` for Pro-only features, bug fixes, and performance improvements
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to CHANGELOG.md : Update `/CHANGELOG.md` for open-source features, bug fixes, breaking changes, and performance improvements
Applied to files:
CHANGELOG.md
📚 Learning: 2025-04-26T21:55:55.874Z
Learnt from: alexeyr-ci2
Repo: shakacode/react_on_rails PR: 1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to {package.json,Rakefile,**/webpack.config.js,config/**/*.js} : Validate that no hardcoded paths need updating after resolving merge conflicts in build configuration files
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-12T16:38:06.537Z
Learnt from: Romex91
Repo: shakacode/react_on_rails PR: 1697
File: package-scripts.yml:28-28
Timestamp: 2025-02-12T16:38:06.537Z
Learning: The file `node_package/lib/ReactOnRails.full.js` is autogenerated during the build process and should not be present in the repository.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to react_on_rails_pro/**/*.{js,ts,jsx,tsx,json,css,scss} : The `react_on_rails_pro/` directory has its own Prettier/ESLint configuration and will be linted separately in CI
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to lib/react_on_rails/**/*.rb : Add RBS type signatures for new Ruby files in `lib/react_on_rails/` by creating corresponding `.rbs` files in `sig/react_on_rails/`
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to lib/react_on_rails/**/*.rb : Validate RBS signatures with `bundle exec rake rbs:validate` and run Steep type checker with `bundle exec rake rbs:steep` for Ruby files
Applied to files:
CHANGELOG.md
📚 Learning: 2025-09-16T08:01:11.146Z
Learnt from: justin808
Repo: shakacode/react_on_rails PR: 1770
File: lib/generators/react_on_rails/templates/base/base/app/javascript/src/HelloWorld/ror_components/HelloWorld.client.jsx:2-2
Timestamp: 2025-09-16T08:01:11.146Z
Learning: React on Rails uses webpack CSS Modules configuration with namedExports: true, which requires the import syntax `import * as style from './file.module.css'` rather than the default export pattern. This configuration enables better tree shaking and bundle size optimization for CSS modules.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-12-16T03:39:07.970Z
Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.970Z
Learning: Applies to packages/react-on-rails/src/**/*.tsx : For React component files, use TypeScript (.tsx extension) and follow the component registry pattern for registration
Applied to files:
CHANGELOG.md
📚 Learning: 2025-09-15T21:24:48.207Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1781
File: node_package/src/ClientSideRenderer.ts:82-95
Timestamp: 2025-09-15T21:24:48.207Z
Learning: In React on Rails, the force_load feature includes both explicit `data-force-load="true"` usage and the ability to hydrate components during the page loading state (`document.readyState === 'loading'`). Both capabilities require a Pro license, so the condition `!railsContext.rorPro && (isComponentForceLoaded || document.readyState === 'loading')` correctly gates both scenarios.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-18T13:08:01.477Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: lib/react_on_rails/helper.rb:190-197
Timestamp: 2025-02-18T13:08:01.477Z
Learning: RSC support validation in React on Rails Pro is handled through a chain of validations:
1. Pro version check in `run_stream_inside_fiber`
2. RSC support check during pack generation via `ReactOnRailsPro.configuration.enable_rsc_support`
3. RSC support validation during component registration
This makes additional validation in the helper methods unnecessary.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-18T13:08:01.477Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: lib/react_on_rails/helper.rb:190-197
Timestamp: 2025-02-18T13:08:01.477Z
Learning: RSC support validation is handled in deeper level calls of the React on Rails Pro codebase, so it doesn't need to be validated again in the `rsc_payload_react_component` helper method.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-13T16:50:47.848Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/clientStartup.ts:18-21
Timestamp: 2025-02-13T16:50:47.848Z
Learning: In the react_on_rails module, the `reactOnRailsPageUnloaded` function in clientStartup.ts is intentionally kept private as it's only used internally as a callback for `onPageUnloaded`.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-02-13T16:50:26.861Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/turbolinksUtils.ts:34-36
Timestamp: 2025-02-13T16:50:26.861Z
Learning: In React on Rails, when checking for Turbolinks version 5 using `turbolinksVersion5()`, always ensure `Turbolinks` exists first by checking `turbolinksInstalled()` to prevent TypeError when accessing properties.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-07-08T05:57:29.630Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1745
File: node_package/src/RSCRequestTracker.ts:8-14
Timestamp: 2025-07-08T05:57:29.630Z
Learning: The global `generateRSCPayload` function in React on Rails Pro (RORP) is provided by the framework during rendering requests, not implemented in application code. The `declare global` statements are used to document the expected interface that RORP will inject at runtime.
Applied to files:
CHANGELOG.md
📚 Learning: 2025-10-23T17:22:01.074Z
Learnt from: AbanoubGhadban
Repo: shakacode/react_on_rails PR: 1875
File: lib/react_on_rails/utils.rb:112-124
Timestamp: 2025-10-23T17:22:01.074Z
Learning: In React on Rails, when Pro is installed but not licensed, the intended behavior is to raise an error on boot. The `react_on_rails_pro?` method validates licenses and should raise errors early (including during path resolution in methods like `server_bundle?`) to enforce licensing requirements rather than failing later with obscure errors.
Applied to files:
CHANGELOG.md
🪛 markdownlint-cli2 (0.18.1)
CHANGELOG.md
5-5: Link text should be descriptive
(MD059, descriptive-link-text)
1734-1734: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: markdown-link-check
- GitHub Check: claude-review
🔇 Additional comments (1)
CHANGELOG.md (1)
1-1868: Link updates align with docs reorganization from PR #1845.All visible documentation URL and local file path changes correctly reflect the reorganized docs structure documented in the PR objectives:
- Website URLs now use correct path structure (e.g.,
/docs/upgrading/upgrading-react-on-railsinstead of/docs/guides/upgrading-react-on-rails)- Local file paths reference correct locations (e.g.,
docs/upgrading/release-notes/16.0.0.md)- Changes are consistent across the changelog
The CHANGELOG.md updates are documentation-only and properly reflect the PR's stated changes. The file follows the pattern of documenting link fixes without modifying functional code.
1 participant
Summary
Fixes all broken links (both local file paths and website URLs) that resulted from the docs reorganization in PR #1845. These links were never updated when the docs were moved to new directories.
Changes
1. Local File Path Fixes (7 fixes across 4 files)
Updated broken
file://and relative path references:docs/release-notes/16.0.0.mddocs/upgrading/release-notes/16.0.0.mdsig/README.mdreact_on_rails/sig/README.mddocs/additional-reading/turbolinks.mddocs/building-features/turbolinks.mddocs/guides/i18n.mddocs/building-features/i18n.mddocs/guides/upgrading-react-on-rails.mddocs/upgrading/upgrading-react-on-rails.mddocs/guides/auto-bundling-file-system-based-automated-bundle-generation.mddocs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation.mdFiles modified:
2. Website URL Fixes (14 fixes across 3 files)
Updated broken shakacode.com documentation URLs:
/docs/guides/upgrading-react-on-rails/docs/upgrading/upgrading-react-on-rails/docs/guides/configuration/docs/api-reference/configuration/docs/guides/rspec_configuration/docs/building-features/rspec-configuration/docs/guides/i18n/docs/building-features/i18n/docs/guides/rails-webpacker-react-integration-options/docs/building-features/rails-webpacker-react-integration-options/docs/rails/turbolinks/docs/building-features/turbolinks/docs/additional-details/migrating-from-react-rails/docs/migrating/migrating-from-react-rails/docs/react-on-rails-pro/react-on-rails-pro/docs/pro/react-on-rails-proFiles modified:
All URLs were returning 404 errors before this fix. Some were missed by the link checker due to caching.
Testing
Verified all broken links fixed:
Related
🤖 Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.