Skip to content

Commit 69c49c1

Browse files
justin808claude
andcommitted
Move docs home copy upstream and fix tutorial anchor (#2671)
Moves the canonical docs-home copy into `docs/README.md` so `reactonrails.com` no longer has to own that prose in `prepare-docs.mjs`. Also fixes the tutorial table-of-contents anchor so it points to the existing `What's Next?` section instead of the stale `#conclusion` anchor. - Replaces the generic docs README with the canonical docs landing content used by the site - Keeps the GitHub-friendly docs website link in the upstream README - Fixes `docs/oss/getting-started/tutorial.md` TOC link from `#conclusion` to `#whats-next` This is the remaining upstream/site-boundary cleanup from the docs work. The site repo should present docs, not own canonical docs content. - `reactonrails.com`: `npm run prepare` - `reactonrails.com`: `npm run build` <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk: documentation-only restructuring and link/anchor fixes with no runtime code changes. > > **Overview** > Updates `docs/README.md` from a GitHub navigation stub to a more opinionated docs landing page that explains OSS vs Pro, reorganizes entry points by user intent, and adds Pro evaluation/help links. > > Fixes the tutorial table-of-contents to link to the existing **“What’s Next?”** section (`#whats-next`) instead of a stale conclusion anchor. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 2cc798e. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> * **Documentation** * Renamed top-level docs to "Documentation Guide" and reframed intro to present OSS vs Pro paths with selection criteria. * Reorganized navigation into path-oriented sections (new app, add-to-app, OSS→Pro evaluation) and consolidated deeper links. * Reduced main Pro feature listings, updated help links, and added a friendly evaluation policy. * Tutorial TOC anchor changed: "Conclusion" → "What's Next?" <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent f5d3445 commit 69c49c1

2 files changed

Lines changed: 35 additions & 61 deletions

File tree

docs/README.md

Lines changed: 34 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,53 @@
1-
# React on Rails Documentation
1+
# Documentation Guide
22

3-
> For the best experience, visit our **[documentation website](https://reactonrails.com/docs/)**.
3+
React on Rails is one product with two tiers: open source for Rails + React integration, and Pro when you need higher SSR throughput, deeper RSC support, or maintainer-backed help.
44

5-
Browsing on GitHub? This guide will help you navigate the documentation.
5+
## Choose the path that matches your app
66

7-
## Open Source (OSS)
7+
### Starting a new Rails + React app
88

9-
The core React on Rails gem and npm package.
9+
- [Create a new app](./oss/getting-started/create-react-on-rails-app.md)
10+
- [Quick Start](./oss/getting-started/quick-start.md)
11+
- [Tutorial — build a complete app](./oss/getting-started/tutorial.md)
1012

11-
### Learning Paths
13+
### Adding React to an existing Rails app
1214

13-
**New to React on Rails?**
15+
- [Install into an existing Rails app](./oss/getting-started/installation-into-an-existing-rails-app.md)
16+
- [Render your first component](./oss/getting-started/using-react-on-rails.md)
1417

15-
1. [Introduction](./oss/introduction.md) - What is React on Rails and why use it?
16-
2. [Quick Start](./oss/getting-started/quick-start.md) - Get your first component running in 15 minutes
17-
3. [Tutorial](./oss/getting-started/tutorial.md) - Build a complete app with Redux and routing
18+
### Already using React on Rails OSS?
1819

19-
**Experienced developers:**
20+
- [Compare OSS and Pro](./oss/getting-started/oss-vs-pro.md)
21+
- [Upgrade to Pro](./pro/upgrading-to-pro.md)
2022

21-
- [Installation Guide](./oss/getting-started/installation-into-an-existing-rails-app.md) - Add to existing Rails app
22-
- [Compare React on Rails to alternatives](./oss/getting-started/comparing-react-on-rails-to-alternatives.md) - Evaluate Hotwire, Inertia Rails, and react-rails
23-
- [API Reference](./oss/api-reference/view-helpers-api.md) - View helpers and JavaScript API
24-
- [Configuration](./oss/configuration/README.md) - All configuration options
25-
- [Core Concepts](./oss/core-concepts/how-react-on-rails-works.md) - Architecture and SSR
23+
### Evaluating Rails + React options
2624

27-
### Categories
25+
- [Examples and migration references](https://reactonrails.com/examples)
26+
- [Compare with alternatives](./oss/getting-started/comparison-with-alternatives.md)
27+
- [Migrate from react-rails](./oss/migrating/migrating-from-react-rails.md)
2828

29-
- [Getting Started](./oss/getting-started/quick-start.md) - Installation, quick start, tutorial
30-
- [Core Concepts](./oss/core-concepts/) - How React on Rails works, SSR, auto-bundling
31-
- [Building Features](./oss/building-features/) - Redux, routing, i18n, testing
32-
- [Configuration](./oss/configuration/README.md) - All configuration options
33-
- [API Reference](./oss/api-reference/) - View helpers and JavaScript API
34-
- [Deployment](./oss/deployment/README.md) - Production deployment and troubleshooting
35-
- [Upgrading](./oss/upgrading/) - Version upgrade guides
36-
- [Changelog](./oss/upgrading/changelog.md) - All notable changes by version
37-
- [Migrating](./oss/migrating/) - From other frameworks
38-
- [Misc](./oss/misc/) - Articles, tips, credits, and other resources
29+
## Dive deeper when you need it
3930

40-
### Quick Reference
31+
- [Introduction](./oss/introduction.md)
32+
- [Core Concepts](./oss/core-concepts/how-react-on-rails-works.md)
33+
- [API Reference](./oss/api-reference/view-helpers-api.md)
34+
- [Deployment and troubleshooting](./oss/deployment/README.md)
35+
- [Configuration](./oss/configuration/README.md)
36+
- [Changelog](./oss/upgrading/changelog.md)
4137

42-
| I want to... | Go here |
43-
| -------------------------------------- | ----------------------------------------------------------------------------------------- |
44-
| **Add React to existing Rails app** | [Installation Guide](./oss/getting-started/installation-into-an-existing-rails-app.md) |
45-
| **Compare Rails + frontend options** | [Comparison Guide](./oss/getting-started/comparing-react-on-rails-to-alternatives.md) |
46-
| **Enable server-side rendering** | [SSR Guide](./oss/core-concepts/react-server-rendering.md) |
47-
| **Set up hot reloading** | [HMR Setup](./oss/building-features/hmr-and-hot-reloading-with-the-webpack-dev-server.md) |
48-
| **Use Redux with Rails** | [Redux Integration](./oss/building-features/react-and-redux.md) |
49-
| **Use TanStack Router** | [TanStack Router Guide](./oss/building-features/tanstack-router.md) |
50-
| **Migrate to React Server Components** | [RSC Migration Guide](./oss/migrating/migrating-to-rsc.md) |
51-
| **Deploy to production** | [Deployment Guide](./oss/deployment/README.md) |
52-
| **Manage page metadata (title, meta)** | [React 19 Native Metadata](./oss/building-features/react-19-native-metadata.md) |
53-
| **Troubleshoot issues** | [Troubleshooting](./oss/deployment/troubleshooting.md) |
54-
| **Compare OSS vs Pro features** | [OSS vs Pro](./oss/getting-started/oss-vs-pro.md) |
55-
| **Compare with alternatives** | [Comparison with Alternatives](./oss/getting-started/comparison-with-alternatives.md) |
38+
## Pro features
5639

57-
## Pro
58-
59-
Performance enhancements, React Server Components, and advanced features. Requires a [React on Rails Pro](https://pro.reactonrails.com/) subscription for production use. Contact [justin@shakacode.com](mailto:justin@shakacode.com) for startup-friendly pricing.
60-
61-
- [Upgrading to Pro](./pro/upgrading-to-pro.md) - Switch from OSS to Pro in three steps
62-
- [Installation](./pro/installation.md) - Set up React on Rails Pro
63-
- [Configuration](./oss/configuration/configuration-pro.md) - Pro-specific settings
6440
- [React Server Components](./pro/react-server-components/tutorial.md) - RSC with Rails
6541
- [Streaming SSR](./oss/building-features/streaming-server-rendering.md) - Progressive server rendering
66-
- [SSR Caching](./oss/building-features/caching.md) - Prerender and fragment caching
67-
- [Bundle Caching](./oss/building-features/bundle-caching.md) - Avoid redundant webpack builds
6842
- [Node Renderer](./oss/building-features/node-renderer/basics.md) - Dedicated Node.js rendering server
69-
- [Code Splitting](./oss/building-features/code-splitting.md) - Loadable components
70-
- [Ruby API (Pro)](./oss/api-reference/ruby-api-pro.md) - Pro view helpers and utilities
71-
- [Upgrading Pro](./pro/updating.md) - Version upgrade guide
72-
- [Troubleshooting](./pro/troubleshooting.md) - Common Pro issues
43+
- [Upgrading to Pro](./pro/upgrading-to-pro.md) - Switch from OSS to Pro in three steps
44+
45+
## Friendly evaluation policy
46+
47+
- You can try React on Rails Pro without a license while evaluating.
48+
- If your organization is budget-constrained, [contact us](mailto:justin@shakacode.com) about free licenses.
7349

74-
## Need Help?
50+
## Need more help?
7551

76-
- [Troubleshooting Guide](./oss/deployment/troubleshooting.md) - Common issues and solutions
77-
- [GitHub Discussions](https://github.com/shakacode/react_on_rails/discussions) - Ask questions
78-
- [React on Rails Pro](https://pro.reactonrails.com/) - Advanced features and professional support
52+
- [GitHub Discussions](https://github.com/shakacode/react_on_rails/discussions)
53+
- [Documentation website](https://reactonrails.com/docs/)

docs/oss/getting-started/tutorial.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ By the time you read this, the latest may have changed. Be sure to check the ver
4040
- [Moving from the Rails default `/app/javascript` to the recommended `/client` structure](#moving-from-the-rails-default-appjavascript-to-the-recommended-client-structure)
4141
- [Custom IP & PORT setup (Cloud9 example)](#custom-ip--port-setup-cloud9-example)
4242
- [RubyMine performance tip](#rubymine-performance-tip)
43-
- [What's Next](#whats-next)
43+
- [What's Next?](#whats-next)
4444

4545
## Installation
4646

@@ -257,7 +257,6 @@ It's super important to exclude certain directories from RubyMine or else it wil
257257
Now that you have React on Rails running, here are ways to level up:
258258

259259
- **Add server-side rendering** — [SSR guide](../core-concepts/react-server-rendering.md)
260-
- **Compare React on Rails to alternatives** — [Comparison guide](./comparing-react-on-rails-to-alternatives.md)
261260
- **See the feature comparison** — [OSS vs Pro](./oss-vs-pro.md)
262261
- **Upgrade to Pro** for React Server Components, streaming SSR, and 10-100x faster SSR — [3-step upgrade guide](../../pro/upgrading-to-pro.md)
263262
- **Explore the full docs** — [Documentation index](../../README.md)

0 commit comments

Comments
 (0)