Fix broken file path links in documentation by ihabadham · Pull Request #2236 · shakacode/react_on_rails

ihabadham · 2025-12-17T00:47:41Z

Summary

Fixes broken file path links identified in #2231.

Changes

File	Fix
CHANGELOG.md:1743	Remove broken `file://` link to deleted generator template (`skip_display_none` is deprecated)
react_on_rails_pro/CONTRIBUTING.md:176	Update branch `more_test_and_docs` → `master`, extension `.js` → `.ts`
react_on_rails_pro/CONTRIBUTING.md:279	Change relative path → absolute GitHub URL (matches documented pattern)

Verification

Confirmed generator template was removed (existed in 2016 commit cae4eeb4)
Confirmed skip_display_none is deprecated per configuration.rb:50
Confirmed Pro repo files exist at master branch URLs (HTTP 200)
Confirmed absolute URL pattern matches CONTRIBUTING.md guidelines for non-doc files

Closes #2231

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation
- Clarified configuration documentation for the skip_display_none option
- Updated internal documentation references to point to current source locations

_{✏️ Tip: You can customize this high-level summary in your review settings.}

- CHANGELOG.md: Remove broken link to deleted generator template (skip_display_none option is now deprecated) - react_on_rails_pro/CONTRIBUTING.md: Update branch reference from deleted `more_test_and_docs` to `master`, fix .js → .ts extension - react_on_rails_pro/CONTRIBUTING.md: Change relative path to absolute GitHub URL for helper.ts (follows documented pattern for non-doc files) Closes #2231 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>

coderabbitai · 2025-12-17T00:47:53Z

Walkthrough

Documentation links are corrected in CHANGELOG.md and CONTRIBUTING.md to reference current file paths and configuration options, fixing broken references to removed generator files and misnamed packages.

Changes

Cohort / File(s)	Change Summary
Documentation link corrections `CHANGELOG.md`	Changelog entry updated to reference configuration option `skip_display_none` instead of pointing to non-existent initializer file path
Documentation path references `react_on_rails_pro/CONTRIBUTING.md`	Multiple documentation links corrected: TypeScript file references updated to point to master branch URLs, and package name in helper.ts path corrected from `node-renderer` to `react-on-rails-pro-node-renderer`

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Verify that the old broken links have been identified correctly
Confirm the new documentation references point to valid, accessible resources
Ensure consistency in how file paths are formatted across both updated files

Suggested labels

bug, review-needed

Suggested reviewers

justin808
AbanoubGhadban
Judahmeek

Poem

🐰 With whiskers twitched and carrot snack,
We fixed the links that led to lack,
No broken paths shall lead astray,
These docs now guide the proper way! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Fix broken file path links in documentation' clearly and specifically summarizes the main changes: correcting broken documentation links.
Linked Issues check	✅ Passed	All coding requirements from issue #2231 are addressed: CHANGELOG.md link removed, CONTRIBUTING.md helper.ts path corrected to react-on-rails-pro-node-renderer, and GitHub URLs updated.
Out of Scope Changes check	✅ Passed	All changes are within scope of fixing broken documentation links as specified in issue #2231; no unrelated modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch ihabadham/fix-file-path-links

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 · 2025-12-17T00:49:00Z

Code Review

This PR successfully fixes broken documentation links. Here's my analysis:

✅ Strengths

Correct fixes for all issues:
- CHANGELOG.md: Removing the broken link to deleted generator template is the right approach since the file no longer exists and skip_display_none is now deprecated (confirmed in configuration.rb:50)
- CONTRIBUTING.md L176: Updated branch more_test_and_docs → master and extension .js → .ts correctly
- CONTRIBUTING.md L279: Changed relative path to absolute GitHub URL, which is more maintainable
Well-researched: PR description shows thorough investigation
- Confirmed template removal in historical commit
- Verified deprecation status
- Checked that Pro repo files exist at master branch
Follows project conventions:
- Uses absolute GitHub URLs for cross-repo references (matches CONTRIBUTING.md patterns)
- Documentation-only changes don't require changelog updates per CLAUDE.md

📋 Minor Observations

Alternative for CHANGELOG.md: You could have linked to current documentation instead of just removing the link, but since skip_display_none is deprecated, removing the reference is cleaner.
Verification: The issue mentioned a second broken link about helper.ts path being wrong (node-renderer vs react-on-rails-pro-node-renderer), but I see you used an absolute GitHub URL instead. This is actually better because:
- Relative paths break when docs are viewed on different platforms
- Absolute URLs to master branch are easier to maintain
- Matches the documented pattern in CONTRIBUTING.md

✅ Final Assessment

LGTM - This is a clean documentation fix that:

Addresses all issues in Fix broken file path links in documentation #2231
Uses appropriate solutions (removed broken link, updated to absolute URLs)
Requires no tests or changelog updates (docs-only change)
Follows project conventions

No blocking issues found. Ready to merge.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

react_on_rails_pro/CONTRIBUTING.md (1)

176-176: Improve link text for better discoverability (minor issue).

The URL update is correct and points to the right TypeScript file in the master branch. However, the link text "here" is not descriptive. Consider using more meaningful link text such as "ReactOnRailsProNodeRenderer.ts" or a more contextual phrase that describes what readers will find at the link. This improves both SEO and readability.

Suggested improvement:

- Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails_pro/blob/master/packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts#L6) in `packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts`
+ Add `console.log('Hello!')` [at line 6 of ReactOnRailsProNodeRenderer.ts](https://github.com/shakacode/react_on_rails_pro/blob/master/packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts#L6) to confirm we're getting an update to the node package.

Or if brevity is preferred:

- Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails_pro/blob/master/packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts#L6) in `packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts`
+ Add `console.log('Hello!')` [in ReactOnRailsProNodeRenderer.ts](https://github.com/shakacode/react_on_rails_pro/blob/master/packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts#L6) to confirm we're getting an update to the node package.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3ef0ff0 and c2c6fed.

📒 Files selected for processing (2)

CHANGELOG.md (1 hunks)
react_on_rails_pro/CONTRIBUTING.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

CHANGELOG.md

📄 CodeRabbit inference engine (CLAUDE.md)

Update /CHANGELOG.md for 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
react_on_rails_pro/CONTRIBUTING.md

🧠 Learnings (19)

📓 Common learnings

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
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

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
Learning: Applies to CHANGELOG.md : Update `/CHANGELOG.md` for open-source features, bug fixes, breaking changes, and performance improvements

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
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-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
react_on_rails_pro/CONTRIBUTING.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
react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
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
react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
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
react_on_rails_pro/CONTRIBUTING.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
react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
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
react_on_rails_pro/CONTRIBUTING.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-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-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
Learning: Exclude directories `/coverage`, `/tmp`, `/gen-examples`, `/packages/react-on-rails/lib`, `/node_modules`, and generated directories from IDE indexing to prevent slowdowns

Applied to files:

CHANGELOG.md
react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
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:

react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2024-12-12T13:07:09.929Z

Learnt from: alexeyr-ci
Repo: shakacode/react_on_rails PR: 1644
File: node_package/src/ReactOnRailsRSC.ts:87-87
Timestamp: 2024-12-12T13:07:09.929Z
Learning: When handling errors in 'node_package/src/ReactOnRailsRSC.ts', include the error stack in error messages in development and test environments to aid debugging.

Applied to files:

react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
Learning: Create webpack debugging scripts in the dummy app root to inspect actual webpack configuration when encountering webpack/Shakapacker issues, then remove debug scripts before committing

Applied to files:

react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
Learning: Applies to react_on_rails/spec/dummy/e2e/playwright/**/*.spec.js : In Playwright E2E tests, use `app('clean')` in `beforeEach` to ensure clean database state, and leverage Rails helpers (appFactories, appEval) instead of UI setup

Applied to files:

react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2024-07-27T10:08:35.868Z

Learnt from: theforestvn88
Repo: shakacode/react_on_rails PR: 1620
File: spec/dummy/client/app/startup/HelloTurboStream.jsx:3-3
Timestamp: 2024-07-27T10:08:35.868Z
Learning: The `RailsContext` import in `spec/dummy/client/app/startup/HelloTurboStream.jsx` is used later in the project, as clarified by the user theforestvn88.

Applied to files:

react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-01-23T18:20:45.824Z

Learnt from: alexeyr-ci
Repo: shakacode/react_on_rails PR: 1687
File: spec/dummy/package.json:0-0
Timestamp: 2025-01-23T18:20:45.824Z
Learning: When adding or updating dependencies in spec/dummy/package.json, maintain version consistency with other package.json files in the codebase to avoid potential version conflicts.

Applied to files:

react_on_rails_pro/CONTRIBUTING.md

📚 Learning: 2025-12-16T03:39:07.980Z

Learnt from: CR
Repo: shakacode/react_on_rails PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-16T03:39:07.980Z
Learning: Applies to react_on_rails/spec/dummy/e2e/playwright/app_commands/**/*.rb : When creating app commands for Playwright tests, place them in `e2e/playwright/app_commands/` with Ruby files that use `CypressOnRails::SmartFactoryWrapper` configuration

Applied to files:

react_on_rails_pro/CONTRIBUTING.md

🪛 markdownlint-cli2 (0.18.1)

react_on_rails_pro/CONTRIBUTING.md

176-176: Link text should be descriptive

(MD059, descriptive-link-text)

⏰ 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 (2)

CHANGELOG.md (1)

1743-1743: LGTM: Removed broken file:// link and referenced configuration option instead.

The change correctly removes the reference to a deleted generator template and replaces it with a reference to the actual skip_display_none configuration option, directly addressing the broken link identified in issue #2231.

react_on_rails_pro/CONTRIBUTING.md (1)

279-279: LGTM: Converted relative path to absolute GitHub URL for non-doc file reference.

The change correctly implements the documentation guideline (line 49) that requires absolute GitHub URLs for references to non-doc files. This ensures the link works correctly both on GitHub and on the ShakaCode docs site, directly addressing the issue identified in PR #2231.

All 15 fixes complete, 2 remaining items covered by PR #2236. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

coderabbitai Bot added bug review-needed labels Dec 17, 2025

coderabbitai Bot reviewed Dec 17, 2025

View reviewed changes

coderabbitai Bot approved these changes Dec 17, 2025

View reviewed changes

claude Bot mentioned this pull request Dec 17, 2025

Fix broken links and update badges #2237

Merged

3 tasks

ihabadham merged commit 0d76d6f into master Dec 18, 2025
4 of 5 checks passed

ihabadham deleted the ihabadham/fix-file-path-links branch December 18, 2025 23:40

coderabbitai Bot mentioned this pull request Dec 26, 2025

fix: add main field to pro packages for legacy resolver compatibility #2256

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix broken file path links in documentation#2236

Fix broken file path links in documentation#2236
ihabadham merged 1 commit intomasterfrom
ihabadham/fix-file-path-links

ihabadham commented Dec 17, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Dec 17, 2025 •

edited

Loading

Uh oh!

claude Bot commented Dec 17, 2025

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

ihabadham commented Dec 17, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Verification

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

claude Bot commented Dec 17, 2025

Code Review

✅ Strengths

📋 Minor Observations

✅ Final Assessment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

ihabadham commented Dec 17, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Dec 17, 2025 •

edited

Loading