Skip to content

Commit 476c4fe

Browse files
justin808claude
andauthored
docs: normalize external GitHub repo slugs in links and generators (#3198)
### 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`, and `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. Also replaces one pre-existing broken `create-remix` link (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 change ### Other Information Affected spec: `react_on_rails/spec/react_on_rails/generators/install_generator_spec.rb` now asserts the new marketplace RSC demo URL string. <!-- CURSOR_SUMMARY --> --- > [!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`, and `react-on-rails-demo-marketplace-rsc`). > > Updates generator-produced link lists (`base_generator`, `demo_page_config`) and corresponding checks in `install_generator_spec.rb` and the `create-react-on-rails-app` smoke test to assert the new URLs. Also fixes a broken `create-remix` link and renames the migration example repo link to `react-on-rails-example-migration`. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 12fef22. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated external repository links and displayed repo names across guides, tutorials, READMEs, and NEWS to use consistent hyphenated naming. * **Chores** * Adjusted generated templates, example links, and header/comment references to point to the renamed example repositories and demo URLs. * **Tests** * Updated smoke/test expectations to match the renamed demo repository links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 3605761 commit 476c4fe

32 files changed

Lines changed: 43 additions & 43 deletions

.claude/docs/analysis/RSPACK_IMPLEMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Rspack Generator Option Implementation
22

3-
This document summarizes the implementation of the `--rspack` option for the React on Rails generator, based on the patterns from [PR #20 in react_on_rails-demos](https://github.com/shakacode/react_on_rails-demos/pull/20).
3+
This document summarizes the implementation of the `--rspack` option for the React on Rails generator, based on the patterns from [PR #20 in react-on-rails-demos](https://github.com/shakacode/react-on-rails-demos/pull/20).
44

55
## Overview
66

.claude/docs/conductor-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ bin/conductor-exec git commit -m "message" # Pre-commit hooks work correctly
105105

106106
## Reference
107107

108-
See [react_on_rails-demos#105](https://github.com/shakacode/react_on_rails-demos/issues/105) for detailed problem analysis and solution development.
108+
See [react-on-rails-demos#105](https://github.com/shakacode/react-on-rails-demos/issues/105) for detailed problem analysis and solution development.

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ _A history of the news. A few bullets at the top will also show on the [README.m
77

88
- **October 1, 2020**: See the [spec/dummy](https://github.com/shakacode/react_on_rails/tree/main/react_on_rails/spec/dummy) example repo for a simple configuration of Webpack via the rails/webpacker gem
99
that supports SSR.
10-
- **August 2, 2020**: See the example repo of [React on Rails Tutorial With SSR, HMR fast refresh, and TypeScript](https://github.com/shakacode/react_on_rails_demo_ssr_hmr) for a new way to set up the creation of your SSR bundle with `rails/webpacker`.
10+
- **August 2, 2020**: See the example repo of [React on Rails Tutorial With SSR, HMR fast refresh, and TypeScript](https://github.com/shakacode/react-on-rails-demo-ssr-hmr) for a new way to set up the creation of your SSR bundle with `rails/webpacker`.
1111
- July 8, 2020: Release **v12**.
1212
1. **React Hooks Support** for top level components
1313
2. **Typescript bindings**

analysis/create-react-on-rails-app-proposal.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ npx create-react-on-rails-app my-app --pro
7171
- Use same CI/CD pipeline
7272
- Published separately to NPM
7373

74-
### 3. Code Reuse from react_on_rails-demos
74+
### 3. Code Reuse from react-on-rails-demos
7575

7676
**Approach:** Port Ruby script logic to TypeScript shell orchestration
7777

@@ -385,11 +385,11 @@ npx create-react-on-rails-app my-app --pro
385385
- Show Pro feature overview
386386
- Provide upgrade path from open source
387387

388-
## Integration with react_on_rails-demos
388+
## Integration with react-on-rails-demos
389389

390390
### Current State
391391

392-
The [react_on_rails-demos](https://github.com/shakacode/react_on_rails-demos) repository has Ruby scripts:
392+
The [react-on-rails-demos](https://github.com/shakacode/react-on-rails-demos) repository has Ruby scripts:
393393

394394
- `bin/new-demo` - Creates basic demos
395395
- `bin/scaffold-demo` - Creates advanced demos with options
@@ -492,7 +492,7 @@ system("npx create-react-on-rails-app #{name} #{flags.join(' ')}")
492492

493493
### Phase 7: Integration (Week 7)
494494

495-
1. Update react_on_rails-demos to use CLI tool
495+
1. Update react-on-rails-demos to use CLI tool
496496
2. Deprecate duplicate Ruby scripts
497497
3. Update demos documentation
498498

@@ -531,11 +531,11 @@ system("npx create-react-on-rails-app #{name} #{flags.join(' ')}")
531531
## Resources
532532

533533
- **Original Issue:** https://github.com/shakacode/react_on_rails/issues/1637
534-
- **react_on_rails-demos:** https://github.com/shakacode/react_on_rails-demos
534+
- **react-on-rails-demos:** https://github.com/shakacode/react-on-rails-demos
535535
- **Similar Tools for Reference:**
536536
- create-react-app: https://github.com/facebook/create-react-app
537537
- create-next-app: https://github.com/vercel/next.js/tree/canary/packages/create-next-app
538-
- create-remix: https://github.com/remix-run/remix/tree/main/packages/create-remix
538+
- create-remix: https://github.com/remix-run/remix
539539

540540
## Next Steps
541541

analysis/open-issue-deep-dive/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@
1818
- #2766 upload-assets endpoint copies all files into all target bundle directories, duplicating bundles -> #2768
1919
- #2614 Replace NDJSON envelope with length-prefixed protocol for Node→Ruby streaming -> #2615
2020
- #2526 RSC migration docs: Structural and framing improvements -> #2661
21-
- #2496 Tracking: Improve RSC/Pro demo DX, version sync, and safety checks -> shakacode/react_on_rails#2797, shakacode/react_on_rails-demos#112
21+
- #2496 Tracking: Improve RSC/Pro demo DX, version sync, and safety checks -> shakacode/react_on_rails#2797, shakacode/react-on-rails-demos#112
2222
- #2457 Make bundle hash depend on asset content for fully immutable bundle directories -> #2534
23-
- #2347 Enhancement: Extensible bin/dev precompile pattern as alternative to precompile_hook -> shakacode/react_on_rails-demos#112
24-
- #1960 feat: add Lefthook for Git hooks management -> shakacode/package_json#32, shakacode/react_on_rails-demos#112
23+
- #2347 Enhancement: Extensible bin/dev precompile pattern as alternative to precompile_hook -> shakacode/react-on-rails-demos#112
24+
- #1960 feat: add Lefthook for Git hooks management -> shakacode/package_json#32, shakacode/react-on-rails-demos#112
2525

2626
## Wave Definitions
2727

bin/conductor-exec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# bin/conductor-exec git commit -m "msg" # Pre-commit hooks work correctly
1515
# bin/conductor-exec pnpm install # Uses correct Node version
1616
#
17-
# See: https://github.com/shakacode/react_on_rails-demos/issues/105
17+
# See: https://github.com/shakacode/react-on-rails-demos/issues/105
1818

1919
if command -v mise &> /dev/null; then
2020
exec mise exec -- "$@"

docs/oss/building-features/rails-webpacker-react-integration-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Webpack's HMR allows the replacement of modules for React in-place without reloa
113113
114114
[github.com/pmmmwh/react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin)
115115
116-
You can see an [example commit adding this in the SSR HMR demo](https://github.com/shakacode/react_on_rails_demo_ssr_hmr/commit/7e53803fce7034f5ecff335db1f400a5743a87e7).
116+
You can see an [example commit adding this in the SSR HMR demo](https://github.com/shakacode/react-on-rails-demo-ssr-hmr/commit/7e53803fce7034f5ecff335db1f400a5743a87e7).
117117
118118
1. Add react refresh packages:
119119
```bash

docs/oss/core-concepts/react-server-rendering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ See also [Client vs. Server Rendering](../core-concepts/client-vs-server-renderi
44

55
## What is the easiest way to set up a Webpack configuration for server-side-rendering?
66

7-
See the example Webpack setup here: [github.com/shakacode/react_on_rails_demo_ssr_hmr](https://github.com/shakacode/react_on_rails_demo_ssr_hmr).
7+
See the example Webpack setup here: [github.com/shakacode/react-on-rails-demo-ssr-hmr](https://github.com/shakacode/react-on-rails-demo-ssr-hmr).
88

99
## What is Server Rendering?
1010

docs/oss/core-concepts/webpack-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ serverWebpackConfig.output = {
110110

111111
**For older Shakapacker versions:** Use hardcoded paths and manual configuration as shown in the generator templates.
112112

113-
Per the example repo [shakacode/react_on_rails_demo_ssr_hmr](https://github.com/shakacode/react_on_rails_demo_ssr_hmr),
113+
Per the example repo [shakacode/react-on-rails-demo-ssr-hmr](https://github.com/shakacode/react-on-rails-demo-ssr-hmr),
114114
you should consider keeping your codebase mostly consistent with the defaults for [Shakapacker](https://github.com/shakacode/shakapacker).
115115

116116
# React on Rails

docs/oss/getting-started/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React on Rails Basic Tutorial
22

3-
_Also see the example repo of [React on Rails Tutorial With SSR, HMR fast refresh, and TypeScript](https://github.com/shakacode/react_on_rails_demo_ssr_hmr)_
3+
_Also see the example repo of [React on Rails Tutorial With SSR, HMR fast refresh, and TypeScript](https://github.com/shakacode/react-on-rails-demo-ssr-hmr)_
44

55
---
66

0 commit comments

Comments
 (0)