Back to React On Rails

Examples Catalog and Repo Naming Plan

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

17.0.18.2 KB
Original Source

Examples Catalog and Repo Naming Plan

Goals

  1. Make React on Rails and React on Rails Pro example repos easy to discover on GitHub.
  2. Make reactonrails.com/examples a clean marketing catalog rather than a random list of historical repos.
  3. Keep canonical taxonomy and example guidance in react_on_rails/docs/.
  4. Reduce future docs churn by routing doc references through one maintained examples page instead of repeating repo slugs everywhere.

Naming Decision

Use these public repo prefixes for anything we want to market actively:

TypePatternWhy
Demoreact-on-rails-demo-*Best for evaluation apps, benchmarks, and feature showcases
Examplereact-on-rails-example-*Best for focused migration and implementation references
Tutorialreact-on-rails-tutorial-*Best for repos that map directly to docs or video lessons

Keep package and product repos as-is:

  • react_on_rails
  • react_on_rails_pro
  • react_on_rails_rsc

Those names are package identities, not marketing slugs.

Repos to Feature Publicly

These are the repos we should feature on reactonrails.com/examples and point to from the docs:

Public repoRecommended actionCanonical statusTarget slugNotes
react-on-rails-demo-ssr-hmrFeatureRename completed(current)Maintained SSR + HMR tutorial repo
react-on-rails-rsc-demoFeatureKeep current slug for nowreact-on-rails-demo-rsc (future)Minimal public RSC starter
react-on-rails-demo-hacker-news-rscFeatureRename completed(current)Compact Pro + RSC showcase
react-on-rails-demo-marketplace-rscFeatureRename completed(current)Performance-focused RSC demo
react-on-rails-demo-gumroad-rscFeatureRename completed(current)Inertia vs React on Rails Pro benchmark
react-on-rails-example-migrationFeatureRename completed(current)Focused react-rails migration reference
react-on-rails-example-open-flightsFeatureRename completed(current)Larger migration reference

Repos to De-emphasize or Archive

These should not appear on the primary public examples page. Some can stay public for historical reference, but they should be archived or treated as legacy once the current catalog is in place.

RepoRecommended actionReason
react_on_rails-hacker-news-appArchive or de-emphasizeDuplicate Hacker News concept; keep one canonical HN repo
spike-react-on-rails-tutorial-v15-with-rspackDe-emphasizeUseful engineering spike, weak marketing name
react_on_rails-v16-generator-playgroundDe-emphasizePlayground/test utility, not a user-facing example
react_on_rails-demo-v16-ssr-auto-registration-bundle-splittingDe-emphasize or rename laterValuable topic, but current slug is too long and version-heavy
react_on_rails-demo-16-4-0-rc5ArchiveRelease snapshot, not a maintained example
test-react-on-rails-v12ArchiveVersion-specific test repo
test-react-on-rails-v12-no-sprocketsArchiveVersion-specific test repo
test-react-on-rails-plus-webpacker-v4ArchiveVersion-specific tutorial repo
react_on_rails-tutorial-v11ArchiveOlder tutorial generation
v8-demoArchiveHistorical version demo
old-react-on-rails-examplesArchiveAlready marked outdated by name
react_on_rails-with-webpackerArchiveHistorical integration prototype
react_on_rails-update-webpack-v2ArchiveHistorical upgrade experiment
react_on_rails-test-new-redux-generationArchivePR-specific experiment repo
react_on_rails-generator-resultsArchiveGenerator output snapshot
react_on_rails-generator-results-pre-0ArchiveGenerator output snapshot
react_on_rails-generator-results-testingArchiveGenerator output snapshot
react_actioncable_counterDe-emphasizeNarrow feature demo, not a primary entry point
rails-tutorial-with-react-on-railsDe-emphasizeHistorical tutorial adaptation
egghead-tutorial-react-on-rails-v6.3.1-create-componentArchive or de-emphasizeVideo-course artifact
egghead-add-redux-component-to-react-on-railsArchive or de-emphasizeVideo-course artifact
react-webpack-rails-tutorialDe-emphasizeLegacy full app; still useful, but not a primary modern starter

Internal Repos

Operational or private repos can matter for maintenance work, but they should not appear in public catalogs or public-facing docs. Keep those references in private planning material only.

  • react-on-rails-demos — shared infrastructure repo for demo apps. Rename completed, but it is not a stand-alone evaluation target, so it stays out of the public examples page.

Docs and Site Follow-up

  1. Keep a canonical examples/reference page in react_on_rails/docs/.
  2. Use reactonrails.com/examples as the marketing-forward catalog.
  3. Replace hard-coded repo links in docs with the maintained examples page when the repo itself is not the main point.
  4. Update GitHub descriptions and topics for all featured repos:
    • react-on-rails
    • react-on-rails-pro
    • react-server-components
    • ruby-on-rails
    • shakapacker
    • rspack where applicable
    • migration, benchmark, or demo as appropriate

Execution Order

  1. Update docs and reactonrails.com/examples first.
  2. Verify GitHub redirects for completed renames before removing any legacy slugs from docs or issue references.
  3. Update repo descriptions and topics.
  4. Archive or de-emphasize legacy repos after the new catalog is live.