Commit 1a4a204
Improve configuration documentation based on code review feedback
Address code review suggestions to improve clarity and usability of
configuration documentation and generated config files.
Key improvements:
Documentation clarity:
- Remove redundant Quick Start code block, reference Essential Configuration instead
- Add clarification that build_test_command is used with TestHelper
- Add context for File-Based Component Registry explaining use cases
- Add stronger warning to server_bundle_output_path with prominent notice
- Add use case guidance for when to override auto-configured settings
- Add "When to disable" guidance for replay_console option
- Add introductory context for I18n configuration section
Generated template improvements:
- Clarify build_test_command usage with TestHelper in comments
- Emphasize that compile: true in shakapacker.yml is preferred alternative
Dummy app improvements:
- Add prominent warning to all dummy app configs to prevent cargo-culting
- Clearly mark as "TEST CONFIGURATION - Do not copy directly for production"
All changes maintain backward compatibility and improve the developer
experience by providing clearer guidance on which options need configuration
and when to override defaults.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>1 parent 1859236 commit 1a4a204
File tree
5 files changed
+27
-25
lines changed- docs/api-reference
- lib/generators/react_on_rails/templates/base/base/config/initializers
- react_on_rails_pro/spec
- dummy/config/initializers
- execjs-compatible-dummy/config/initializers
- spec/dummy/config/initializers
5 files changed
+27
-25
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
| 9 | + | |
19 | 10 | | |
20 | 11 | | |
21 | 12 | | |
| |||
65 | 56 | | |
66 | 57 | | |
67 | 58 | | |
68 | | - | |
| 59 | + | |
69 | 60 | | |
70 | 61 | | |
71 | 62 | | |
| |||
141 | 132 | | |
142 | 133 | | |
143 | 134 | | |
144 | | - | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
145 | 138 | | |
146 | 139 | | |
147 | 140 | | |
| |||
165 | 158 | | |
166 | 159 | | |
167 | 160 | | |
168 | | - | |
| 161 | + | |
169 | 162 | | |
170 | 163 | | |
171 | 164 | | |
| |||
178 | 171 | | |
179 | 172 | | |
180 | 173 | | |
181 | | - | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
182 | 177 | | |
183 | 178 | | |
184 | | - | |
| 179 | + | |
| 180 | + | |
185 | 181 | | |
186 | 182 | | |
187 | 183 | | |
| |||
325 | 321 | | |
326 | 322 | | |
327 | 323 | | |
328 | | - | |
| 324 | + | |
329 | 325 | | |
330 | 326 | | |
331 | 327 | | |
332 | 328 | | |
333 | 329 | | |
| 330 | + | |
| 331 | + | |
334 | 332 | | |
335 | 333 | | |
336 | 334 | | |
| |||
427 | 425 | | |
428 | 426 | | |
429 | 427 | | |
| 428 | + | |
| 429 | + | |
430 | 430 | | |
431 | 431 | | |
432 | 432 | | |
| |||
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| |||
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
| |||
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
0 commit comments