Skip to content

docs: restore absolute URL for node-renderer testing example#3179

Merged
justin808 merged 1 commit intomainfrom
jg/3165-followup-absolute-doc-link
Apr 19, 2026
Merged

docs: restore absolute URL for node-renderer testing example#3179
justin808 merged 1 commit intomainfrom
jg/3165-followup-absolute-doc-link

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Apr 19, 2026

Summary

Follow-up to #3165. Now that react_on_rails_pro/spec/dummy/renderer/node-renderer.js exists on main, switches the testing-example link in docs/oss/building-features/node-renderer/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 (Docusaurus / reactonrails.com/docs), where cross-package relative links may not resolve.

Test plan

  • Lychee pre-commit hook passes on the changed file
  • Prettier passes
  • curl https://github.com/shakacode/react_on_rails/blob/main/react_on_rails_pro/spec/dummy/renderer/node-renderer.js returns 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.md to 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

  • Documentation
    • Updated a testing example reference link to point to an external GitHub repository, enhancing documentation accessibility while preserving the reference material.

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]>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 81e93461-371f-48a6-8942-7ffa70e4ce91

📥 Commits

Reviewing files that changed from the base of the PR and between 952216d and 10da4a9.

📒 Files selected for processing (1)
  • docs/oss/building-features/node-renderer/js-configuration.md

Walkthrough

A 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

Cohort / File(s) Summary
Documentation Link Update
docs/oss/building-features/node-renderer/js-configuration.md
Changed "Testing example" link target from local relative reference to external GitHub URL while preserving link text.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A link hops forth to distant shores,
From relative paths to GitHub's doors,
The text remains, the reference flies,
To documentation's clearer skies! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: restoring an absolute URL for a documentation link to the node-renderer testing example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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/3165-followup-absolute-doc-link

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.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 19, 2026

Greptile Summary

Restores the absolute GitHub URL for the node-renderer testing example link in docs/oss/building-features/node-renderer/js-configuration.md, reverting the temporary relative-path workaround introduced in #3165. This is a one-line docs change with no code impact.

Confidence Score: 5/5

Safe 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

Filename Overview
docs/oss/building-features/node-renderer/js-configuration.md Single-line change restoring the absolute GitHub URL for the testing example link; no logic changes.

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
Loading

Reviews (1): Last reviewed commit: "docs: use absolute URL for node-renderer..." | Re-trigger Greptile

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 19, 2026

Code Review

Overview: 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:

  • Cross-package relative paths do not resolve on the Docusaurus-published site at reactonrails.com/docs, since the Pro package is a separate directory tree at build time.
  • Absolute GitHub URLs are the right pattern for cross-package references in docs.

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:

  • Link target exists (PR author verified 200 response)
  • Lychee link check passes
  • No runtime/API impact
  • Consistent with how other absolute GitHub links appear in the docs

@justin808 justin808 merged commit 80f33e1 into main Apr 19, 2026
12 checks passed
@justin808 justin808 deleted the jg/3165-followup-absolute-doc-link branch April 19, 2026 08:41
justin808 added a commit that referenced this pull request Apr 23, 2026
…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
justin808 added a commit that referenced this pull request Apr 23, 2026
…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)
  ...
justin808 added a commit that referenced this pull request Apr 23, 2026
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant