Skip to content

Commit f0923ca

Browse files
justin808claude
andcommitted
Fix documentation issues and add CHANGELOG entry
1. Fix broken link in configuration-deprecated.md - Changed from non-existent release-notes path to CHANGELOG.md 2. Improve generator template clarity - Added 'Two mutually exclusive approaches' heading - Makes it clearer that users should choose ONE approach 3. Add CHANGELOG entry for documentation improvements - Documents configuration simplification - Documents new testing guide - Documents Doctor enhancements Addresses reviewer feedback on documentation quality. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 5c236c8 commit f0923ca

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ Changes since the last non-beta release.
5353

5454
- **`generated_component_packs_loading_strategy` now defaults based on Pro license**: When using Shakapacker >= 8.2.0, the default loading strategy is now `:async` for Pro users and `:defer` for non-Pro users. This provides optimal performance for Pro users while maintaining compatibility for non-Pro users. You can still explicitly set the strategy in your configuration. [PR #1993](https://github.com/shakacode/react_on_rails/pull/1993) by [AbanoubGhadban](https://github.com/AbanoubGhadban).
5555

56+
#### Documentation
57+
58+
- **Simplified Configuration Files**: Improved configuration documentation and generator template for better clarity and usability. Reduced generator template from 67 to 42 lines (37% reduction). Added comprehensive testing configuration guide. Reorganized configuration docs into Essential vs Advanced sections. Enhanced Doctor program with diagnostics for server rendering and test compilation consistency. [PR 2011](https://github.com/shakacode/react_on_rails/pull/2011) by [justin808](https://github.com/justin808).
59+
5660
#### Deprecated
5761

5862
- **Node Renderer Configuration**: Renamed `bundlePath` configuration option to `serverBundleCachePath` in the node renderer to better describe its purpose and avoid confusion with Shakapacker's public bundle path. The old `bundlePath` option continues to work with deprecation warnings. Both `RENDERER_SERVER_BUNDLE_CACHE_PATH` (new) and `RENDERER_BUNDLE_PATH` (deprecated) environment variables are supported. [PR #2008](https://github.com/shakacode/react_on_rails/pull/2008) by [justin808](https://github.com/justin808).

docs/api-reference/configuration-deprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ config.defer_generated_component_packs = true
4343
config.generated_component_packs_loading_strategy = :defer
4444
```
4545

46-
See the [16.0.0 Release Notes](../upgrading/release-notes/16.0.0.md) for more details.
46+
See [CHANGELOG.md](../../CHANGELOG.md) for more details.
4747

4848
## Need Help?
4949

lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb.tt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ ReactOnRails.configure do |config|
1313
config.server_bundle_js_file = "server-bundle.js"
1414

1515
################################################################################
16-
# Test Configuration (Optional - see below)
16+
# Test Configuration (Optional)
1717
################################################################################
18+
# Two mutually exclusive approaches - use ONE of the following:
19+
#
1820
# RECOMMENDED: Set `compile: true` in config/shakapacker.yml for test environment
1921
# This is simpler and handled automatically by Shakapacker.
2022
#

0 commit comments

Comments
 (0)