Skip to content

Commit 5b95c4a

Browse files
justin808claude
andcommitted
Address optional review nits on examples catalog
- Note the rsc-demo slug exception in the public docs and prefer linking the docs page over the repo URL. - Point contributors from the public Legacy Repos section to the internal examples-catalog and repo-naming plan. - Add a Target slug column to the planning table so the rsc-demo exception is visible at a glance. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d1dae10 commit 5b95c4a

2 files changed

Lines changed: 18 additions & 10 deletions

File tree

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ starting from.
2323
React on Rails Pro.
2424
- Note: this repo uses React on Rails Pro. See [OSS vs Pro](./oss-vs-pro.md)
2525
for evaluation guidance.
26+
- Note: this slug predates the `react-on-rails-demo-*` naming convention used
27+
by the other demos on this page. It may be renamed to
28+
`react-on-rails-demo-rsc` in a future cleanup, so prefer linking to this
29+
docs page rather than the repo URL directly.
2630

2731
## In-Repo Reference
2832

@@ -84,5 +88,9 @@ point for new evaluations.
8488

8589
- Legacy full app: [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) — older production-style app with a [live demo at reactrails.com](https://reactrails.com). Still useful as a historical reference, but not the recommended starting point for new projects.
8690

91+
For the full list of repos being de-emphasized or archived, see the internal
92+
[examples-catalog and repo-naming plan](../../../internal/planning/examples-catalog-and-repo-naming-plan.md)
93+
in this repository.
94+
8795
If you are choosing a public reference repo for docs, talks, or adoption work,
8896
start with the repos above.

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

Lines changed: 10 additions & 10 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-
| 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 |
36+
| Public repo | Recommended action | Canonical status | Target slug | Notes |
37+
| ------------------------------------- | ------------------ | ------------------------- | ---------------------------------- | ----------------------------------------- |
38+
| `react-on-rails-demo-ssr-hmr` | Feature | Rename completed | (current) | Maintained SSR + HMR tutorial repo |
39+
| `react-on-rails-rsc-demo` | Feature | Keep current slug for now | `react-on-rails-demo-rsc` (future) | Minimal public RSC starter |
40+
| `react-on-rails-demo-hacker-news-rsc` | Feature | Rename completed | (current) | Compact Pro + RSC showcase |
41+
| `react-on-rails-demo-marketplace-rsc` | Feature | Rename completed | (current) | Performance-focused RSC demo |
42+
| `react-on-rails-demo-gumroad-rsc` | Feature | Rename completed | (current) | Inertia vs React on Rails Pro benchmark |
43+
| `react-on-rails-example-migration` | Feature | Rename completed | (current) | Focused `react-rails` migration reference |
44+
| `react-on-rails-example-open-flights` | Feature | Rename completed | (current) | Larger migration reference |
45+
| `react-on-rails-demos` | Feature | Rename completed | (current) | Shared infrastructure repo for demo apps |
4646

4747
## Repos to De-emphasize or Archive
4848

0 commit comments

Comments
 (0)