docs: normalize external GitHub repo slugs in links and generators#3198
docs: normalize external GitHub repo slugs in links and generators#3198
Conversation
|
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)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThis pull request updates GitHub repository reference strings across docs, templates, tests, and scripts, changing underscore-based slugs to hyphenated equivalents (e.g., Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 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 SummaryThis PR performs a mechanical, cross-cutting normalization of GitHub repository slugs — replacing underscored/old slug forms ( Confidence Score: 5/5Safe to merge — all changes are URL string corrections with no runtime logic impact. Every change is a textual slug substitution in documentation, comments, or string literals. Generator Ruby code and its spec are kept in sync. The smoke-test grep is updated to match the new slug. No logic, data, or security concerns are present. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Old slug references] --> B{File type}
B --> C[Docs / Markdown\ndocs/, NEWS.md, analysis/]
B --> D[Generator templates\n*.js.tt]
B --> E[Generator Ruby source\nbase_generator.rb\ndemo_page_config.rb]
B --> F[Specs & smoke tests\ninstall_generator_spec.rb\nsmoke-test-local-gems.sh]
B --> G[Pro dummy fixtures\nreact_on_rails_pro/spec/]
C --> C1[react_on_rails_demo_ssr_hmr\n→ react-on-rails-demo-ssr-hmr]
C --> C2[react_on_rails-demos\n→ react-on-rails-demos]
C --> C3[react-on-rails-migration-example\n→ react-on-rails-example-migration]
D --> D1[react_on_rails_demo_ssr_hmr\n→ react-on-rails-demo-ssr-hmr]
E --> E1[react-server-components-marketplace-demo\n→ react-on-rails-demo-marketplace-rsc]
F --> F1[Assertions / greps updated\nto match new slugs]
G --> G1[react_on_rails_demo_ssr_hmr\n→ react-on-rails-demo-ssr-hmr]
Reviews (1): Last reviewed commit: "docs: normalize external GitHub repo slu..." | Re-trigger Greptile |
Code Review — PR #3198: Normalize external GitHub repo slugsOverall: Clean, well-scoped docs maintenance PR. The changes are purely link/slug normalization with no runtime logic affected. The test and smoke-test script are correctly updated to match the new URL strings. What looks good
Things worth double-checking before merging1. Deep-link file paths in webpack template comments The generator These point to specific files on the 2. This is a word-order swap, not just hyphen normalization. The PR description says this is the canonical repo name — just a quick sanity-check that 3.
Minor nitThe two Verdict: LGTM pending confirmation that the |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
size-limit report 📦
|
coderabbitai
Bot
added
review-needed
documentation
docs-cleanup
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Review summary — addressedI (Claude Code) triaged all 6 review comments. No code changes required; all concerns verified locally. Inline questions (verified, threads resolved)
Other reviews
All review threads are now resolved. Ready for merge once CI is green. |
|
Tip For best results, initiate chat on the files or code changes.
[resolve] 🧠 Learnings used |
|
Thanks for the thorough follow-up. All concerns are verified — the deep links resolve correctly, the |
Updates stale GitHub repo references across docs, generator templates, and specs to match the canonical repository slugs: - react_on_rails_demo_ssr_hmr -> react-on-rails-demo-ssr-hmr - react_on_rails-demos -> react-on-rails-demos - react-server-components-marketplace-demo -> react-on-rails-demo-marketplace-rsc - react-on-rails-migration-example -> react-on-rails-example-migration Generator templates, demo page config, and the create-react-on-rails-app smoke-test grep are updated alongside docs so freshly generated apps link to the correct repos. The main shakacode/react_on_rails repo slug is intentionally preserved. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
justin808
force-pushed
the
jg/repo-slug-cleanup
branch
from
c13efe5 to
f66aa3c
Compare
Code Review: PR #3198 — Normalize external GitHub repo slugsOverviewStraightforward housekeeping: normalizes stale external repo slugs across docs, generator templates, Ruby config files, smoke-test scripts, and RSpec expectations. No runtime behavior changes. What's Good
Issues1. Possible missed update:
|
Line 38 still referenced the old slug react-on-rails-migration-example despite PR #3198 listing the rename to react-on-rails-example-migration. New slug verified to resolve to the correct repo. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
|
Thanks for the review. Addressing both findings: Finding #1 — Finding #2 — |
Review round 2 — addressedI (Claude Code) triaged the 3 new review comments posted after the first round. Summary: Fixed
Skipped (duplicates of already-verified concerns)
All threads resolved. PR ready for merge review. |
| @@ -1,5 +1,5 @@ | |||
| // The source code including full typescript support is available at: | |||
| // https://github.com/shakacode/react_on_rails_demo_ssr_hmr/blob/master/config/webpack/webpackConfig.js | |||
| // https://github.com/shakacode/react-on-rails-demo-ssr-hmr/blob/master/config/webpack/webpack.config.js | |||
There was a problem hiding this comment.
The filename in this URL changed from webpackConfig.js to webpack.config.js — that's a different change from all the other files in this PR, which only updated the repo slug and preserved the referenced filename.
Every other webpack config template comment in this PR (clientWebpackConfig.js, serverWebpackConfig.js, commonWebpackConfig.js, development.js, production.js, test.js) keeps its original filename. Only this one silently renamed the file.
Please confirm: does the react-on-rails-demo-ssr-hmr repo actually have the file at config/webpack/webpack.config.js (with a dot), or should this remain webpackConfig.js to match the others?
| // https://github.com/shakacode/react-on-rails-demo-ssr-hmr/blob/master/config/webpack/webpack.config.js | |
| // https://github.com/shakacode/react-on-rails-demo-ssr-hmr/blob/master/config/webpack/webpackConfig.js |
Code ReviewOverall: This is a clean, low-risk docs/link normalization PR. The changes are mechanical and well-scoped. One issue and one minor observation below. One Issue to Verify
Positive Notes
No Concerns
|
1 participant
Summary
Updates stale GitHub repo references across docs, generator templates, and specs to match the canonical repository slugs —
react_on_rails_demo_ssr_hmr→react-on-rails-demo-ssr-hmr,react_on_rails-demos→react-on-rails-demos,react-server-components-marketplace-demo→react-on-rails-demo-marketplace-rsc, andreact-on-rails-migration-example→react-on-rails-example-migration. Generator templates,demo_page_config, and thecreate-react-on-rails-appsmoke-test grep are updated alongside docs so freshly generated apps link to the correct repos; the mainshakacode/react_on_railsrepo slug is intentionally preserved. Also replaces one pre-existing brokencreate-remixlink (surfaced by the lychee pre-push hook) with the valid repo root URL.Pull Request checklist
[ ] Add/update test to cover these changes— link-text only[ ] Update documentation— this PR is the doc update[ ] Update CHANGELOG file— no user-facing runtime changeOther Information
Affected spec:
react_on_rails/spec/react_on_rails/generators/install_generator_spec.rbnow asserts the new marketplace RSC demo URL string.Note
Low Risk
Low risk: changes are limited to documentation/comment/link updates plus matching spec/smoke-test string expectations, with no runtime behavior changes.
Overview
Normalizes external GitHub links across docs, generator templates, and generated landing-page configs to use the canonical repo slugs (notably
react-on-rails-demo-ssr-hmr,react-on-rails-demos, andreact-on-rails-demo-marketplace-rsc).Updates generator-produced link lists (
base_generator,demo_page_config) and corresponding checks ininstall_generator_spec.rband thecreate-react-on-rails-appsmoke test to assert the new URLs. Also fixes a brokencreate-remixlink and renames the migration example repo link toreact-on-rails-example-migration.Reviewed by Cursor Bugbot for commit 12fef22. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
Documentation
Chores
Tests