Skip to content

Commit 29f37b6

Browse files
committed
More updates
1 parent 318a420 commit 29f37b6

File tree

8 files changed

+17
-14
lines changed

8 files changed

+17
-14
lines changed

docs/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ Jump to what you need
3232

3333
### 🏗️ **Migrating from Other Solutions**
3434

35-
- **[From react-rails](./guides/migration/from-react-rails.md)**
36-
- **[From Webpacker](./guides/migration/from-webpacker.md)**
37-
- **[From custom setup](./guides/migration/from-custom.md)**
35+
- **[From react-rails](./additional-details/migrating-from-react-rails.md)** - Switch from the react-rails gem
36+
- **[Upgrading React on Rails](./guides/upgrading-react-on-rails.md)** - Version upgrade guide
3837

3938
## 🎯 Popular Use Cases
4039

@@ -158,8 +157,7 @@ Find guidance for your specific scenario:
158157
### Migration Guides
159158

160159
- [Upgrading React on Rails](./guides/upgrading-react-on-rails.md)
161-
- [From Webpacker to Shakapacker](./guides/migration/webpacker-to-shakapacker.md)
162-
- [From react-rails](./guides/migration/from-react-rails.md)
160+
- [From react-rails gem](./additional-details/migrating-from-react-rails.md)
163161

164162
### Troubleshooting
165163

docs/additional-details/recommended-project-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ you should consider keeping your codebase mostly consistent with the defaults fo
1919

2020
1. Move the directory:
2121

22-
```sh
22+
```bash
2323
mv app/javascript client
2424
```
2525

docs/getting-started.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ The best way to understand React on Rails depends on your situation:
2727

2828
## System Requirements
2929

30+
**🚨 React on Rails 16.0+** (this guide covers modern features)
31+
**🚨 Shakapacker 7+** (required for React on Rails 16)
3032
**Rails 7+** (Rails 5+ supported)
3133
**Ruby 3.0+** (Ruby 2.7+ supported)
3234
**Node.js 18+**
33-
**Shakapacker 7** (or Shakapacker 6 with [special setup](./additional-details/tips-for-usage-with-sp6.md))
3435

3536
> **Don't have Shakapacker?** It's the modern replacement for Webpacker and required for React on Rails.
3637

docs/guides/rails-webpacker-react-integration-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ You can see an example commit of adding this [here](https://github.com/shakacode
142142

143143
1. Add the `react-hot-loader` and ` @hot-loader/react-dom` npm packages.
144144

145-
```sh
145+
```bash
146146
yarn add --dev react-hot-loader @hot-loader/react-dom
147147
```
148148

docs/javascript/capistrano-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ end
1212

1313
Then run Bundler to ensure Capistrano is downloaded and installed:
1414

15-
```sh
15+
```bash
1616
bundle install
1717
```
1818

File renamed without changes.
File renamed without changes.

docs/quick-start/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ This guide will have you rendering React components in your Rails app as quickly
88

99
Before starting, make sure you have:
1010

11-
- **Rails 7+** application
12-
- **Ruby 3.0+**
11+
- **🚨 React on Rails 16.0+** (this guide)
12+
- **🚨 Shakapacker 7+** (required for React on Rails 16)
13+
- **Rails 7+** application (Rails 5+ supported)
14+
- **Ruby 3.0+** (Ruby 2.7+ supported)
1315
- **Node.js 18+** and **Yarn**
1416
- **Basic familiarity** with React and Rails
1517

@@ -132,9 +134,11 @@ Note, your layout needs to include this in the <head>:
132134
That's it! React on Rails will automatically:
133135

134136
- ✅ Find your component in any directory named `ror_components` (configurable)
135-
- ✅ Create the webpack bundle
136-
- ✅ Register the component
137-
- ✅ Include the JavaScript on the page
137+
- ✅ Create optimized webpack bundles with code splitting
138+
- ✅ Register the component for immediate use
139+
- ✅ Include only necessary JavaScript on each page (reduces bundle size)
140+
141+
> **🚀 Performance Tip:** Auto-bundling automatically optimizes your JavaScript delivery by only loading components used on each page, significantly reducing initial bundle size compared to manual bundling.
138142
139143
Restart your server and visit the page - you should see your interactive counter!
140144

0 commit comments

Comments
 (0)