|
1 | | -# React on Rails Documentation |
| 1 | +# Documentation Guide |
2 | 2 |
|
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. |
4 | 4 |
|
5 | | -Browsing on GitHub? This guide will help you navigate the documentation. |
| 5 | +## Choose the path that matches your app |
6 | 6 |
|
7 | | -## Open Source (OSS) |
| 7 | +### Starting a new Rails + React app |
8 | 8 |
|
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) |
10 | 12 |
|
11 | | -### Learning Paths |
| 13 | +### Adding React to an existing Rails app |
12 | 14 |
|
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) |
14 | 17 |
|
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? |
18 | 19 |
|
19 | | -**Experienced developers:** |
| 20 | +- [Compare OSS and Pro](./oss/getting-started/oss-vs-pro.md) |
| 21 | +- [Upgrade to Pro](./pro/upgrading-to-pro.md) |
20 | 22 |
|
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 |
26 | 24 |
|
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) |
28 | 28 |
|
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 |
39 | 30 |
|
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) |
41 | 37 |
|
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 |
56 | 39 |
|
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 |
64 | 40 | - [React Server Components](./pro/react-server-components/tutorial.md) - RSC with Rails |
65 | 41 | - [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 |
68 | 42 | - [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. |
73 | 49 |
|
74 | | -## Need Help? |
| 50 | +## Need more help? |
75 | 51 |
|
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/) |
0 commit comments