Skip to content

Commit 5b07560

Browse files
justin808claude
andcommitted
Improve configuration documentation based on code review feedback
- Reorganize Essential Configuration to focus on recommended options only - Move file-based component registry docs to existing sibling document - Clarify build_test_command should prefer shakapacker.yml compile setting - Add guidance that prerender is typically set per-component - Note logging_on_server behavior with Pro Node Renderer - Move rendering extensions to new Common Configuration section - Clarify same_bundle_for_client_and_server should almost never be true - Note server_bundle_output_path default doesn't need manual setting - Split Pro features into configuration-pro.md - Split deprecated options into configuration-deprecated.md - Simplify generator template to match documentation changes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent e0e820a commit 5b07560

File tree

4 files changed

+178
-148
lines changed

4 files changed

+178
-148
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Deprecated Configuration Options
2+
3+
This document lists configuration options that have been deprecated or removed from React on Rails.
4+
5+
For current configuration options, see [configuration.md](configuration.md).
6+
7+
## Removed Options
8+
9+
### immediate_hydration
10+
11+
**Status:** ⚠️ REMOVED in v17.0
12+
13+
This configuration option has been removed. Immediate hydration is now automatically enabled for Pro users and disabled for non-Pro users.
14+
15+
**Migration:** Remove any `config.immediate_hydration` lines from your configuration. Use per-component overrides if needed:
16+
17+
```ruby
18+
# Pro users can disable for specific components:
19+
react_component("MyComponent", immediate_hydration: false)
20+
21+
# Non-Pro users: immediate_hydration is ignored
22+
```
23+
24+
See [CHANGELOG.md](../CHANGELOG.md) for details.
25+
26+
## Deprecated Options
27+
28+
### defer_generated_component_packs
29+
30+
**Type:** Boolean
31+
**Default:** `false`
32+
**Status:** ⚠️ DEPRECATED
33+
34+
**Deprecated:** Use `generated_component_packs_loading_strategy = :defer` instead.
35+
36+
**Migration:**
37+
38+
```ruby
39+
# Old (deprecated):
40+
config.defer_generated_component_packs = true
41+
42+
# New:
43+
config.generated_component_packs_loading_strategy = :defer
44+
```
45+
46+
See the [16.0.0 Release Notes](../upgrading/release-notes/16.0.0.md) for more details.
47+
48+
## Need Help?
49+
50+
- **Documentation:** [React on Rails Guides](https://www.shakacode.com/react-on-rails/docs/)
51+
- **Support:** [ShakaCode Forum](https://forum.shakacode.com/)
52+
- **Consulting:** [[email protected]](mailto:[email protected])
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# React on Rails Pro Configuration Options
2+
3+
This document describes configuration options specific to React on Rails Pro features.
4+
5+
For general React on Rails configuration options, see [configuration.md](configuration.md).
6+
7+
## React Server Components (RSC)
8+
9+
React Server Components and Streaming SSR are React on Rails Pro features.
10+
11+
For detailed configuration of RSC and streaming features, see the Pro package documentation:
12+
[react_on_rails_pro/docs/configuration.md](https://github.com/shakacode/react_on_rails/blob/master/react_on_rails_pro/docs/configuration.md)
13+
14+
### Key Pro Configurations
15+
16+
These options are configured in the `ReactOnRailsPro.configure` block:
17+
18+
- `rsc_bundle_js_file` - Path to RSC bundle
19+
- `react_client_manifest_file` - Client component manifest for RSC
20+
- `react_server_client_manifest_file` - Server manifest for RSC
21+
- `enable_rsc_support` - Enable React Server Components
22+
23+
### Example Configuration
24+
25+
```ruby
26+
# config/initializers/react_on_rails_pro.rb
27+
ReactOnRailsPro.configure do |config|
28+
config.rsc_bundle_js_file = "rsc-bundle.js"
29+
config.react_client_manifest_file = "client-manifest.json"
30+
config.react_server_client_manifest_file = "server-manifest.json"
31+
config.enable_rsc_support = true
32+
end
33+
```
34+
35+
See the Pro documentation for complete setup instructions.
36+
37+
## Need Help?
38+
39+
- **Pro Features:** [React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)
40+
- **Consulting:** [[email protected]](mailto:[email protected])

0 commit comments

Comments
 (0)