docs: add user guide

codeigniter4 · Mar 7, 2024 · f5b0345 · f5b0345
1 parent c90a27e
commit f5b0345
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/user_guide_src/source/changelogs/v4.5.0.rst b/user_guide_src/source/changelogs/v4.5.0.rst
@@ -24,6 +24,7 @@ Enhancements
 Commands
 ========
 
+- Added ``spark optimize`` command to optimize configuration for production environment.
 - Added ``spark make:test`` command to generate a skeleton test file. See
   :ref:`cli-generators-make-test` for the details.
 - Added ``spark config:check`` command to check Config values. See

diff --git a/user_guide_src/source/concepts/autoloader.rst b/user_guide_src/source/concepts/autoloader.rst
@@ -187,13 +187,18 @@ You can use the ``spark cache:clear`` command:
 
 Or simply delete the **writable/cache/FileLocatorCache** file.
 
+.. note::
+    The ``spark optimize`` command clears the cache.
+
 How to Enable FileLocator Caching
 =================================
 
 Set the following property to ``true`` in **app/Config/Optimize.php**::
 
     public bool $locatorCacheEnabled = true;
 
+Or you can enable it with the ``spark optimize`` command.
+
 .. note::
     This property cannot be overridden by
     :ref:`environment variables <configuration-classes-and-environment-variables>`.
diff --git a/user_guide_src/source/concepts/factories.rst b/user_guide_src/source/concepts/factories.rst
@@ -313,6 +313,9 @@ You can use the ``spark cache:clear`` command:
 
 Or simply delete the **writable/cache/FactoriesCache_config** file.
 
+.. note::
+    Since v4.5.0, the ``spark optimize`` command clears the cache.
+
 How to Enable Config Caching
 ============================
 
@@ -322,6 +325,8 @@ Set the following property to ``true`` in **app/Config/Optimize.php**::
 
     public bool $configCacheEnabled = true;
 
+Since v4.5.0, you can enable this with the ``spark optimize`` command.
+
 .. note::
     This property cannot be overridden by
     :ref:`environment variables <configuration-classes-and-environment-variables>`.