Skip to content

Commit 746ab34

Browse files
committed
Normalize examples catalog repo slugs
1 parent 75fc22c commit 746ab34

4 files changed

Lines changed: 32 additions & 22 deletions

File tree

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ React on Rails is one product with two tiers: open source for Rails + React inte
2222

2323
### Evaluating Rails + React options
2424

25-
- [Examples and migration references](./oss/getting-started/examples-and-references.md)
25+
- [Examples and migration references](./oss/getting-started/examples-and-references.md) — maintained starters, migration repos, and Pro + RSC demos
2626
- [Example migrations](./oss/migrating/example-migrations.md) — curated migration references and proof criteria
2727
- [Examples gallery](https://reactonrails.com/examples) — reactonrails.com showcase apps
2828
- [Compare with alternatives](./oss/getting-started/comparing-react-on-rails-to-alternatives.md) — decision guide covering Hotwire, Inertia, Next.js, and more

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

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

docs/oss/getting-started/examples-and-references.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ starting from.
1212

1313
### SSR + HMR Tutorial Demo
1414

15-
- Repo: [shakacode/react_on_rails_demo_ssr_hmr](https://github.com/shakacode/react_on_rails_demo_ssr_hmr)
15+
- Repo: [shakacode/react-on-rails-demo-ssr-hmr](https://github.com/shakacode/react-on-rails-demo-ssr-hmr)
1616
- Use it when you want the maintained Rails + React + SSR + HMR walkthrough repo
1717
that backs the tutorial and Webpack configuration guidance.
1818

@@ -36,15 +36,18 @@ starting from.
3636

3737
## Migration References
3838

39+
For detailed proof criteria and migration contribution guidance, see
40+
[Example Migrations](../migrating/example-migrations.md).
41+
3942
### Migrate from `react-rails`
4043

41-
- Repo: [shakacode/react-on-rails-migration-example](https://github.com/shakacode/react-on-rails-migration-example)
44+
- Repo: [shakacode/react-on-rails-example-migration](https://github.com/shakacode/react-on-rails-example-migration)
4245
- Use it when you want a focused before/after migration reference instead of
4346
reconstructing the upgrade from older blog posts.
4447

4548
### Open Flights Migration Example
4649

47-
- Repo: [shakacode/react-on-rails-open-flights-example](https://github.com/shakacode/react-on-rails-open-flights-example)
50+
- Repo: [shakacode/react-on-rails-example-open-flights](https://github.com/shakacode/react-on-rails-example-open-flights)
4851
- Use it when you want a larger example app that shows React on Rails replacing
4952
`react-rails` in a more realistic codebase.
5053

@@ -55,16 +58,24 @@ starting from.
5558
5659
### Hacker News RSC Demo
5760

58-
- Repo: [shakacode/react-on-rails-hn-rsc-demo](https://github.com/shakacode/react-on-rails-hn-rsc-demo)
61+
- Repo: [shakacode/react-on-rails-demo-hacker-news-rsc](https://github.com/shakacode/react-on-rails-demo-hacker-news-rsc)
5962
- Use it when you want a compact public demo of React on Rails Pro with React
6063
Server Components on a familiar read-heavy UI.
6164

6265
### Marketplace RSC Performance Demo
6366

64-
- Repo: [shakacode/react-server-components-marketplace-demo](https://github.com/shakacode/react-server-components-marketplace-demo)
67+
- Repo: [shakacode/react-on-rails-demo-marketplace-rsc](https://github.com/shakacode/react-on-rails-demo-marketplace-rsc)
6568
- Use it when you want a public performance-oriented RSC demo showing the shape
6669
of the user-visible win on a marketplace-style surface.
6770

71+
### Gumroad-Style RSC Benchmark Demo
72+
73+
- Repo: [shakacode/react-on-rails-demo-gumroad-rsc](https://github.com/shakacode/react-on-rails-demo-gumroad-rsc)
74+
- Use it when you want a benchmark-oriented comparison between an Inertia-style
75+
surface and a React on Rails Pro + RSC surface on the same product domain.
76+
- Note: this is a ShakaCode-built demo modeled on a Gumroad-style UI, not an
77+
official Gumroad product or integration.
78+
6879
## Legacy Repos
6980

7081
Version-specific demos, `test-*` repos, generator snapshots, and older tutorial

internal/planning/examples-catalog-and-repo-naming-plan.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ Those names are package identities, not marketing slugs.
3333
These are the repos we should feature on `reactonrails.com/examples` and point
3434
to from the docs:
3535

36-
| Current repo | Recommended action | Proposed canonical name | Notes |
37-
| ------------------------------------------ | ------------------ | ------------------------------------- | ----------------------------------------- |
38-
| `react_on_rails_demo_ssr_hmr` | Rename | `react-on-rails-demo-ssr-hmr` | Maintained SSR + HMR tutorial repo |
39-
| `react-on-rails-rsc-demo` | Rename | `react-on-rails-demo-rsc-starter` | Minimal public RSC starter |
40-
| `react-on-rails-hn-rsc-demo` | Rename | `react-on-rails-demo-hacker-news-rsc` | Compact Pro + RSC showcase |
41-
| `react-server-components-marketplace-demo` | Rename | `react-on-rails-demo-marketplace-rsc` | Performance-focused RSC demo |
42-
| `gumroad-rsc` | Rename | `react-on-rails-demo-gumroad-rsc` | Inertia vs React on Rails Pro benchmark |
43-
| `react-on-rails-migration-example` | Rename | `react-on-rails-example-migration` | Focused `react-rails` migration reference |
44-
| `react-on-rails-open-flights-example` | Rename | `react-on-rails-example-open-flights` | Larger migration reference |
45-
| `react_on_rails-demos` | Rename | `react-on-rails-demos` | Shared infrastructure repo for demo apps |
36+
| Public repo | Recommended action | Canonical status | Notes |
37+
| ------------------------------------- | ------------------ | ------------------------- | ----------------------------------------- |
38+
| `react-on-rails-demo-ssr-hmr` | Feature | Rename completed | Maintained SSR + HMR tutorial repo |
39+
| `react-on-rails-rsc-demo` | Feature | Keep current slug for now | Minimal public RSC starter |
40+
| `react-on-rails-demo-hacker-news-rsc` | Feature | Rename completed | Compact Pro + RSC showcase |
41+
| `react-on-rails-demo-marketplace-rsc` | Feature | Rename completed | Performance-focused RSC demo |
42+
| `react-on-rails-demo-gumroad-rsc` | Feature | Rename completed | Inertia vs React on Rails Pro benchmark |
43+
| `react-on-rails-example-migration` | Feature | Rename completed | Focused `react-rails` migration reference |
44+
| `react-on-rails-example-open-flights` | Feature | Rename completed | Larger migration reference |
45+
| `react-on-rails-demos` | Feature | Rename completed | Shared infrastructure repo for demo apps |
4646

4747
## Repos to De-emphasize or Archive
4848

@@ -99,8 +99,7 @@ private planning material only.
9999
## Execution Order
100100

101101
1. Update docs and `reactonrails.com/examples` first.
102-
2. After the docs PRs land and demo links are verified, open a tracking issue
103-
for the rename/archive rollout.
104-
3. Rename active featured repos.
105-
4. Update repo descriptions/topics.
106-
5. Archive or de-emphasize legacy repos after the new catalog is live.
102+
2. Verify GitHub redirects for completed renames before removing any legacy
103+
slugs from docs or issue references.
104+
3. Update repo descriptions and topics.
105+
4. Archive or de-emphasize legacy repos after the new catalog is live.

0 commit comments

Comments
 (0)