Updates page strcuture of documentation

Signed-off-by: Frank Brückner <[email protected]>

Author: froschdesign

docs/book/index.md

@@ -1 +0,0 @@
-../../README.md

docs/book/introduction.md

@@ -0,0 +1,20 @@
+# Introduction
+
+This package supplies a [laminas-config-aggregator post processor](https://docs.laminas.dev/laminas-config-aggregator/config-post-processors/)
+that consumes the [Symfony DependencyInjection ParameterBag](https://symfony.com/doc/current/configuration/using_parameters_in_dic.html)
+in order to allow users to define parameters to re-use within their
+configuration.
+
+As an example, one could define an API key, cache path, or other common
+filesystem location _once_ as a _parameter_, and then refer to that parameter
+_multiple times_ within the configuration, in order to simplify updates to the
+value.
+
+Parameters are referenced within configuration using `%name%` notation.
+Parameters may be defined as nested associative arrays as well; in such cases, a
+`.` character references an additional layer of hierarchy to dereference:
+`%foo.bar%` refers to the paramter found at `'foo' => [ 'bar' => 'value' ]`.
+
+> Available since version 1.1.0
+
+Parameters which reference other parameters can also be used.

docs/book/parameter-lazy-loading.md

@@ -0,0 +1,9 @@
+# Parameter Lazy Loading
+
+> Available since version 1.4.0
+
+If your parameters are resolved from a database, redis, consul, or any other i/o
+resource, you can use the `LazyParameterPostProcessor` which consumes just a
+`callable` which can provide the parameters.
+
+In case you are using config-caching, the i/o is not executed when performed in the `callable`.

docs/book/usage.md

@@ -1,24 +1,5 @@
 # Basic Usage
 
-This package supplies a [laminas-config-aggregator post processor](https://docs.laminas.dev/laminas-config-aggregator/config-post-processors/)
-that consumes the [Symfony DependencyInjection ParameterBag](https://symfony.com/doc/current/configuration/using_parameters_in_dic.html)
-in order to allow users to define parameters to re-use within their
-configuration.
-
-As an example, one could define an API key, cache path, or other common
-filesystem location _once_ as a _parameter_, and then refer to that parameter
-_multiple times_ within the configuration, in order to simplify updates to the
-value.
-
-Parameters are referenced within configuration using `%name%` notation.
-Parameters may be defined as nested associative arrays as well; in such cases, a
-`.` character references an additional layer of hierarchy to dereference:
-`%foo.bar%` refers to the paramter found at `'foo' => [ 'bar' => 'value' ]`.
-
-> Available since version 1.1.0 
-
-Parameters which reference other parameters can also be used.
-
 If you wish to use a literal `%name%` within your configuration, you **must**
 double-escape the percentage signs: `%%name%%`. Failure to do so will result in
 an exception when post-processing the configuration.
@@ -84,14 +65,3 @@ array(5) {
   }
 }
 ```
-
-## Parameter Lazy Loading
-
-> Available since version 1.4.0 
-
-If your parameters are resolved from a database, redis, consul, or any other i/o
-resource, you can use the `LazyParameterPostProcessor` which consumes just a
-`callable` which can provide the parameters.
-
-In case you are using config-caching, the i/o is not executed when performed in
-the `callable`.

mkdocs.yml

@@ -3,8 +3,14 @@ docs_dir: docs/book
 site_dir: docs/html
 nav:
     - Home: index.md
+    - Introduction: introduction.md
     - Basic Usage: usage.md
+    - Parameter Lazy Loading: parameter-lazy-loading.md
 site_description: 'PostProcessor extension for laminas/laminas-config-aggregator to allow usage of templated parameters within your configuration'
 repo_url: 'https://github.com/laminas/laminas-config-aggregator-parameters'
 extra:
     project: Components
+    related_documentations:
+        headline: Related Components
+        links:
+            - laminas-config-aggregator: https://docs.laminas.dev/laminas-config-aggregator/