docs: restore absolute URL for node-renderer testing example#3179
docs: restore absolute URL for node-renderer testing example#3179
Conversation
Now that PR #3165 has merged and `react_on_rails_pro/spec/dummy/renderer/node-renderer.js` exists on `main`, switch the testing-example link in `js-configuration.md` from a cross-package relative path back to an absolute GitHub URL. The relative path was a temporary workaround so the lychee link check would pass before the file existed at its new location; absolute URLs render correctly on the published documentation site, where relative cross-package links may not resolve. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|
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 (1)
WalkthroughA documentation link was updated to point to an external GitHub URL instead of a relative file reference, directing readers to the same example file in the shakacode/react_on_rails repository. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 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 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 SummaryRestores the absolute GitHub URL for the node-renderer testing example link in Confidence Score: 5/5Safe to merge — documentation-only change with a verified URL. The change is a single-line docs update replacing a relative path with a verified absolute URL. No code, logic, or configuration is affected. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["js-configuration.md\n(Docusaurus page)"] -->|"absolute GitHub URL"| B["github.com/shakacode/react_on_rails\n/blob/main/react_on_rails_pro/spec/dummy/renderer/node-renderer.js"]
style B fill:#d4edda,stroke:#28a745
Reviews (1): Last reviewed commit: "docs: use absolute URL for node-renderer..." | Re-trigger Greptile |
Code ReviewOverview: Single-line documentation change that restores an absolute GitHub URL for a testing example link, reverting a temporary relative-path workaround from #3165. Assessment: LGTM The change is correct and well-motivated:
One minor note: The URL uses blob/main, which is hardcoded to the main branch. This is the standard convention for documentation links to source examples and is consistent with how other cross-repo links work in the docs — no action needed. Checklist:
|
…ons-docs * origin/main: chore: remove redundant --rsc-pro install generator flag (#3105) ci: warn (don't fail) on Bencher main regression (#3168) test: enable RSpec --profile to surface slowest package tests (#3176) fix(node-renderer): expose performance in VM context when supportModules (#3158) docs: remove stale immediate_hydration references (#3139) (#3159) docs: restore absolute URL for node-renderer testing example (#3179) Bump Rspack dependencies to v2 (^2.0.0-0) (#3084) chore: remove obsolete webpack <5.106.0 pin (#3175) Move Node Renderer entry point to renderer/ directory (#3165) docs: address RSC pitfalls review follow-ups (#3155) (#3156) docs: remove fabricated DevConsole reference, link verified RSC tools (#2527) (#3163) # Conflicts: # docs/oss/building-features/node-renderer/js-configuration.md
…ging' into jg/3122-rolling-deploy-adapter * origin/jg/3122-unify-renderer-cache-staging: (39 commits) fix(specs): boot dummy specs without readline and drop redundant pnpm workspace (#3190) docs: add RSC migration success stories page (#1985) (#3162) Fix Bencher reporting permanently broken on pushes to main (#3148) docs: add example migrations guide (#3126) docs: remove defunct guavapass.com reference (#3199) chore: remove redundant --rsc-pro install generator flag (#3105) ci: warn (don't fail) on Bencher main regression (#3168) test: enable RSpec --profile to surface slowest package tests (#3176) fix(node-renderer): expose performance in VM context when supportModules (#3158) docs: remove stale immediate_hydration references (#3139) (#3159) docs: restore absolute URL for node-renderer testing example (#3179) Bump Rspack dependencies to v2 (^2.0.0-0) (#3084) chore: remove obsolete webpack <5.106.0 pin (#3175) Move Node Renderer entry point to renderer/ directory (#3165) docs: address RSC pitfalls review follow-ups (#3155) (#3156) docs: remove fabricated DevConsole reference, link verified RSC tools (#2527) (#3163) Scaffold CI workflow and build scripts for first-run consistency (#3097) Add OPTIONAL triage tier and fix recommendations to /address-review (#3161) chore: sync Gemfile.lock with term-ansicolor 1.11.3 (#3164) Simplify the docs sidebar and Pro landing pages (#3119) ...
* origin/main: fix(specs): boot dummy specs without readline and drop redundant pnpm workspace (#3190) docs: add RSC migration success stories page (#1985) (#3162) Fix Bencher reporting permanently broken on pushes to main (#3148) docs: add example migrations guide (#3126) docs: remove defunct guavapass.com reference (#3199) chore: remove redundant --rsc-pro install generator flag (#3105) ci: warn (don't fail) on Bencher main regression (#3168) test: enable RSpec --profile to surface slowest package tests (#3176) fix(node-renderer): expose performance in VM context when supportModules (#3158) docs: remove stale immediate_hydration references (#3139) (#3159) docs: restore absolute URL for node-renderer testing example (#3179) Bump Rspack dependencies to v2 (^2.0.0-0) (#3084) chore: remove obsolete webpack <5.106.0 pin (#3175) Move Node Renderer entry point to renderer/ directory (#3165) docs: address RSC pitfalls review follow-ups (#3155) (#3156) # Conflicts: # CHANGELOG.md
Summary
Follow-up to #3165. Now that
react_on_rails_pro/spec/dummy/renderer/node-renderer.jsexists onmain, switches the testing-example link indocs/oss/building-features/node-renderer/js-configuration.mdfrom a cross-package relative path back to an absolute GitHub URL.The relative path was a temporary workaround so the lychee link check would pass before the file existed at its new location. Absolute URLs render correctly on the published documentation site (Docusaurus /
reactonrails.com/docs), where cross-package relative links may not resolve.Test plan
curl https://github.com/shakacode/react_on_rails/blob/main/react_on_rails_pro/spec/dummy/renderer/node-renderer.jsreturns 200🤖 Generated with Claude Code
Note
Low Risk
Low risk documentation-only change that updates a single link target with no runtime or API impact.
Overview
Restores the testing example link in
docs/oss/building-features/node-renderer/js-configuration.mdto an absolute GitHub URL (instead of a cross-package relative path), so the link resolves correctly on the published documentation site.Reviewed by Cursor Bugbot for commit 10da4a9. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit