[Docs]Update document for changing view_component_path (#1870)

* Update document for changing view_component_path * Update docs/CHANGELOG.md * Update docs/guide/generators.md --------- Co-authored-by: Cameron Dutro <[email protected]>
ViewComponent · Oct 18, 2023 · f087bcf · f087bcf
1 parent d10f9ae
commit f087bcf
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -18,6 +18,10 @@ nav_order: 5
 
     *Alexandre Ignjatovic*
 
+* Update generators.md to clarify the way of changing `config.view_component.view_component_path`.
+
+    *Shozo Hatta*
+
 * Improve docs about inline templates interpolation
 
     *Hans Lemuet*

diff --git a/docs/guide/generators.md b/docs/guide/generators.md
@@ -38,7 +38,13 @@ bin/rails generate component Sections::Example title content
 
 You can specify options when running the generator. To alter the default values project-wide, define the configuration settings described in [API docs](/api.html#configuration).
 
-Generated ViewComponents are added to `app/components` by default. Set `config.view_component.view_component_path` to use a different path.
+Generated ViewComponents are added to `app/components` by default. Set `config.view_component.view_component_path` to use a different path. Note that you need to add the same path to `config.eager_load_paths` as well.
+
+```ruby
+# config/application.rb
+config.view_component.view_component_path = "app/views/components"
+config.eager_load_paths << Rails.root.join("app/views/components")
+```
 
 ### Override template engine