From 9db2f7891415af3f19580362d2be4a50ff267a92 Mon Sep 17 00:00:00 2001
From: cytopia <cytopia@everythingcli.org>
Date: Wed, 30 Nov 2022 01:04:24 +0100
Subject: [PATCH] Adjust documentation

---
 README.md                                  |  7 +++++--
 doc/PHP-EXT-options.yml.md                 |  6 ------
 doc/PHP-EXT-test.yml.md                    |  3 ---
 doc/{ => contributor}/PHP-EXT-build.yml.md | 11 +++++++++++
 doc/contributor/PHP-EXT-options.yml.md     | 17 +++++++++++++++++
 doc/contributor/PHP-EXT-test.yml.md        | 14 ++++++++++++++
 doc/php-modules.md                         |  1 +
 php_modules/README.md                      | 11 +++++++++++
 8 files changed, 59 insertions(+), 11 deletions(-)
 delete mode 100644 doc/PHP-EXT-options.yml.md
 delete mode 100644 doc/PHP-EXT-test.yml.md
 rename doc/{ => contributor}/PHP-EXT-build.yml.md (93%)
 create mode 100644 doc/contributor/PHP-EXT-options.yml.md
 create mode 100644 doc/contributor/PHP-EXT-test.yml.md

diff --git a/README.md b/README.md
index 301c44c..a64216b 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@
 This repository will provide you fully functional PHP-FPM Docker images in different flavours,
 versions and packed with different types of integrated PHP modules. It also solves the problem of **[syncronizing file permissions](doc/syncronize-file-permissions.md)** of mounted volumes between the host and the container.
 
-:information_source: For detauls see **[Documentation: Syncronize File Permissions](doc/syncronize-file-permissions.md)**
+:information_source: For details see **[Documentation: Syncronize File Permissions](doc/syncronize-file-permissions.md)**
 
 
 <h2><img id="docker-tags" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Docker Tags</h2>
@@ -190,7 +190,8 @@ cat doc/php_modules.md | grep href | sed 's|</a.*||g' | sed 's|.*">||g' | xargs
 [`zip`](php_modules/zip/)
 [`zlib`](php_modules/zlib/)
 
-:information_source: For detauls see **[Documentation: PHP Modules](doc/php-modules.md)**
+:information_source: For details see **[Documentation: PHP Modules](doc/php-modules.md)**<br/>
+:information_source: For details see **[Contributor Documentation: PHP Modules](php_modules/README.md)**
 
 
 
@@ -447,6 +448,8 @@ Docker images are built and tested every night by **[GitHub Actions](https://git
 
 Contributors are welcome. Feel free to star and clone this repository and submit issues and pull-requests. Add examples and show what you have created with the provided images. If you see any errors or ways to improve this repository in any way, please do so.
 
+:information_source: For details see **[Contributor Documentation: PHP Modules](php_modules/README.md)**
+
 
 <h2><img id="community" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Community</h2>
 
diff --git a/doc/PHP-EXT-options.yml.md b/doc/PHP-EXT-options.yml.md
deleted file mode 100644
index 6a0d0e6..0000000
--- a/doc/PHP-EXT-options.yml.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# Extension definition: `options.yml`
-
-To be done
-
-
-For now have a look at the existing modules into the respective `options.yml` files as they are mostly the same.
diff --git a/doc/PHP-EXT-test.yml.md b/doc/PHP-EXT-test.yml.md
deleted file mode 100644
index ea47fb8..0000000
--- a/doc/PHP-EXT-test.yml.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Extension definition: `test.yml`
-
-This is not yet implemented and thus no documentation exists.
diff --git a/doc/PHP-EXT-build.yml.md b/doc/contributor/PHP-EXT-build.yml.md
similarity index 93%
rename from doc/PHP-EXT-build.yml.md
rename to doc/contributor/PHP-EXT-build.yml.md
index 19297fe..83def9b 100644
--- a/doc/PHP-EXT-build.yml.md
+++ b/doc/contributor/PHP-EXT-build.yml.md
@@ -1,3 +1,14 @@
+[PHP Mods: Overview](../../php_modules/README.md) |
+[PHP Mods: `options.yml`](PHP-EXT-options.yml.md) |
+PHP Mods: `build.yml` |
+[PHP Mods: `test.yml`](PHP-EXT-test.yml.md)
+
+---
+
+<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
+
+
+
 # Extension definition: `build.yml`
 
 
diff --git a/doc/contributor/PHP-EXT-options.yml.md b/doc/contributor/PHP-EXT-options.yml.md
new file mode 100644
index 0000000..4fa5848
--- /dev/null
+++ b/doc/contributor/PHP-EXT-options.yml.md
@@ -0,0 +1,17 @@
+[PHP Mods: Overview](../../php_modules/README.md) |
+PHP Mods: `options.yml` |
+[PHP Mods: `build.yml`](PHP-EXT-build.yml.md) |
+[PHP Mods: `test.yml`](PHP-EXT-test.yml.md)
+
+---
+
+<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
+
+
+
+# Extension definition: `options.yml`
+
+To be done
+
+
+For now have a look at the existing modules into the respective `options.yml` files as they are mostly the same.
diff --git a/doc/contributor/PHP-EXT-test.yml.md b/doc/contributor/PHP-EXT-test.yml.md
new file mode 100644
index 0000000..d4f25e3
--- /dev/null
+++ b/doc/contributor/PHP-EXT-test.yml.md
@@ -0,0 +1,14 @@
+[PHP Mods: Overview](../../php_modules/README.md) |
+[PHP Mods: `options.yml`](PHP-EXT-options.yml.md) |
+[PHP Mods: `build.yml`](PHP-EXT-build.yml.md) |
+PHP Mods: `test.yml`
+
+---
+
+<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
+
+
+
+# Extension definition: `test.yml`
+
+This is not yet implemented and thus no documentation exists.
diff --git a/doc/php-modules.md b/doc/php-modules.md
index c1c38bb..45fb065 100644
--- a/doc/php-modules.md
+++ b/doc/php-modules.md
@@ -14,6 +14,7 @@ Extensions |
 <h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Documentation</h2>
 
 
+:information_source: For details on how to add/edit modules see **[Contributor Documentation: PHP Modules](../php_modules/README.md)**
 
 #### PHP Modules (`base`)
 
diff --git a/php_modules/README.md b/php_modules/README.md
index 1736a88..2107aa2 100644
--- a/php_modules/README.md
+++ b/php_modules/README.md
@@ -1,3 +1,14 @@
+PHP Mods: Overview |
+[PHP Mods: `options.yml`](../doc/contributor/PHP-EXT-options.yml.md) |
+[PHP Mods: `build.yml`](../doc/contributor/PHP-EXT-build.yml.md) |
+[PHP Mods: `test.yml`](../doc/contributor/PHP-EXT-test.yml.md)
+
+---
+
+<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
+
+
+
 # PHP Module definitions
 
 This document describes how to create new or alter existing PHP module definitions.