Add documentation #4

docs/development/documentation/index.md

@@ -1,32 +1,46 @@
 # Documentation
 
-- README.rst
-- CHANGELOG.md
-- docs/
-- MkDocs
-- mkdocstrings
+## README
+The repository contains a `README.rst` file with basic information. <br>
+It gives a short introduction to the project and links to other relevant files.
 
+## Changelog
+The `CHANGELOG.md` is a record of all notable changes made to a project. <br>
+It is structured by each release and divided by additions, changes, and removals. <br>
 
 ## MkDocs
+[MkDocs](https://www.mkdocs.org/) is a fast and simple static site generator that is used for documentation. <br>
+The source files are written in [Markdown](https://www.markdownguide.org/cheat-sheet/), and configured with `mkdocs.yml`. <br>
+[Material theme](https://squidfunk.github.io/mkdocs-material/) enables 
+additional features and an elegant design.
 
 ### Install
-Install the required packages. <br>
-`pip install mkdocs` install MkDocs <br>
-`pip install mkdocs-material` install the material theme
+Install the required packages in a python environment. <br>
+💻 `pip install mkdocs` install MkDocs <br>
+💻 `pip install mkdocs-material` install the material theme
 
 ### Build
-Generate the documentation. <br>
-`mkdocs serve` start the local live version of the documentation <br>
-`mkdocs build` create a folder `site` with the documentation
+Generate the documentation locally. <br>
+💻 `mkdocs serve` start the local live version of the documentation <br>
+💻 `mkdocs build` create a folder `site` with the documentation
 
 ### Publish
 
 #### Manually
 Publish documentation on **GitHub Pages**. <br>
-`mkdocs gh-deploy` manually deploys the documentation files
+💻 `mkdocs gh-deploy` manually deploys the documentation files
 
 #### GitHub Action
-Deploy the documentation with **GitHub Actions**. <br>
+🐙 Deploy the documentation with **GitHub Actions**. <br>
 The file `.github\workflows\gh-pages.yml` creates an automated GitHub workflow. <br>
 It is configured to be pushed to the branch `gh-page` and then deployed online. <br>
 A commit on the `production` branch triggers the workflow. 
+
+## mkdocstrings
+[mkdocstrings](https://mkdocstrings.github.io/) generates automatic 
+documentation (autodocs) from [Google style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). <br>
+💻 `pip install mkdocstrings` install mkdocstrings
+
+
+!!! note "Used Icons"
+    🐙 GitHub | 💠 git | 📝 File | 💻 Command Line