Skip to content

Commit 982e805

Browse files
justin808claude
andcommitted
Mark immediate_hydration as deprecated in configuration documentation
- Add clear deprecation notice with 🚫 DEPRECATED marker - Explain that the option now logs warnings but has no effect - Note that immediate hydration is automatically enabled for Pro users - Provide action required: remove the config line - Include historical context about what the setting used to do - Reference CHANGELOG.md for migration instructions Fixes documentation to match the deprecation shim in configuration.rb (lib/react_on_rails/configuration.rb:79-113) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 4a90b8f commit 982e805

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

docs/api-reference/configuration.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,11 +280,23 @@ ReactOnRails.configure do |config|
280280
# See [16.0.0 Release Notes](docs/release-notes/16.0.0.md) for more details.
281281
# config.defer_generated_component_packs = false
282282

283-
# Default is false
284-
# React on Rails Pro (licensed) feature: When true, components hydrate immediately as soon as
285-
# their server-rendered HTML reaches the client, without waiting for the full page load.
286-
# This improves time-to-interactive performance.
287-
config.immediate_hydration = false
283+
################################################################################
284+
# DEPRECATED CONFIGURATION
285+
################################################################################
286+
# 🚫 DEPRECATED: immediate_hydration is no longer used
287+
#
288+
# This configuration option has been removed. Immediate hydration is now
289+
# automatically enabled for React on Rails Pro users and cannot be disabled.
290+
#
291+
# If you still have this in your config, it will log a deprecation warning:
292+
# config.immediate_hydration = false # ⚠️ Logs warning, has no effect
293+
#
294+
# Action Required: Remove this line from your config/initializers/react_on_rails.rb
295+
# See CHANGELOG.md for migration instructions.
296+
#
297+
# Historical Context:
298+
# Previously controlled whether Pro components hydrated immediately upon their
299+
# server-rendered HTML reaching the client, vs waiting for full page load.
288300

289301
################################################################################
290302
# I18N OPTIONS

0 commit comments

Comments
 (0)