Extend readme and add first documentation. Add new version of jet

README.md

@@ -7,6 +7,10 @@ JDAV to send newsletters, manage user lists and keep material lists up to date.
 As this repository is also meant to be a base for exchange during development, feel free
 to contribute ideas in form of edits to this README, issues, landmarks, projects, wiki entries, ...
 
+# Documentation 
+
+The first raw version of the documentation can be found in [. > documentation > README.md](./documentation/README.md).
+
 # Docker
 
 In the `docker` subfolder, there are `docker-compose.yaml`s for development and production use. For the development
@@ -34,7 +38,7 @@ The following can be useful in case that automatic migrations throw errors.
 
 ## Information
 
-- default user wie vergeben in Schritt 3 [Development Setup > docker](#docker)
+- default user as defined in step 3 [Development Setup > docker](#docker)
 
 ## Development Setup 
 
@@ -60,13 +64,12 @@ cd docker/development
 docker compose up -d
 ```
 
-Erläuterungen:
-- zu 2.: Im docker compose sollen die gleichen Nutzerrechte vorliegen, wie auf der entwickelnden Maschine um auto rebuild zu ermöglichen. Damit 
-
+Description:
+- to 2.: The docker container should habe the same Userrights as the developing machine
 
 ### Known Issues
 
-- Bei `docker compose up -d` des development [docker-compose.yaml](docker/development/docker-compose.yaml)
+- When excuting `docker compose up -d` from development [docker-compose.yaml](docker/development/docker-compose.yaml)
 
   ```bash
    => ERROR [master 6/7] RUN groupadd -g  kasimir && useradd -g  -u  -m -d /app kasimir                                                                                                                0.2s
@@ -77,4 +80,4 @@ Erläuterungen:
   failed to solve: process "/bin/sh -c groupadd -g $GID $USER && useradd -g $GID -u $UID -m -d /app $USER" did not complete successfully: exit code: 3
   ```
 
-  - Dieser Fehler entsteht, wenn Schritt 2 im Abschnitt [Development Setup > docker](#docker) übersprungen wird.
+  - This error gets raised if step 2 [Development Setup > docker](#docker) is skipped

documentation/README.md

@@ -0,0 +1,38 @@
+Stand: 12.11.2023
+
+# Technical ocumentation -- jdav kompass
+
+Until this point there was no documentation, so everything added is by someone who hasn't coded in this project at all and doesn't no anything about the project. But at least a documentation exists now.
+
+## About
+
+The **jdav kompass** is an modular internal management platform providing tools for member-, material-, mail- and financemanagement. It has its source in jdav Ludwigsburg and has a enhanced second version for jdav heideleberg.
+
+## Technical Base
+
+- Python 3.9
+- Django 4.0.1
+
+
+## Documentation Roadmap
+
+- [ ] Add applications (/modules) overview
+- [ ] Create datmodel in draw.io
+- [ ] 
+
+
+## Ideas by Kasimir
+
+Loose collection of smaller and bigger enhancements that came to my mind.
+
+- [ ] Write documentatione ;)
+- [ ] Restructure the sidebar menu (make it more intuitive)
+- [ ] Create a Dashboard as startpage instead of the module list
+- [ ] Material manager
+    - [ ] Update structure so that every item is an own data entry (remove the count attribute) (needed for PSA log)
+    - [ ] Add Attribute for unique ID to each item (needed for PSA log)
+    - [ ] Add an more extensive PSA log 
+- [ ] User Help 
+    - [ ] Add tooltips with helptexts
+- [ ] More Modules
+    - [ ] Add a Newsletter Module (supporting mjml)