From 2b8d45afc76f4f45365e514877b1e4dcad0508af Mon Sep 17 00:00:00 2001
From: Tim Friedrich Weber <tfw@satware.com>
Date: Wed, 10 Apr 2024 09:31:37 +0200
Subject: [PATCH 1/2] Optimized and added comments to CSS code in u10.css

---
 docs/stylesheets/u10.css | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

diff --git a/docs/stylesheets/u10.css b/docs/stylesheets/u10.css
index 66916de..10c3861 100644
--- a/docs/stylesheets/u10.css
+++ b/docs/stylesheets/u10.css
@@ -1,3 +1,4 @@
+/* Change the background and text color of selected text */
 ::-moz-selection {
     background: #3B7EA5;
     color: #fff;
@@ -7,87 +8,101 @@
     color: #fff;
 }
 
+/* Customize the scrollbar width */
 ::-webkit-scrollbar {
     width: 10px;
 }
 
-/* Track */
+/* Customize the scrollbar track */
 ::-webkit-scrollbar-track {
     background: #fff;
     border-radius: 0;
 }
 
-/* Handle */
+/* Customize the scrollbar handle */
 ::-webkit-scrollbar-thumb {
     background: #3B7EA5;
 }
 
+/* Change the border color of info admonitions and details */
 .md-typeset .admonition.info, .md-typeset details.info {
-        border-color: #3B7EA5;
+    border-color: #3B7EA5;
 }
 
+/* Change the background color of the title and summary of info admonitions */
 .md-typeset .info>.admonition-title:before, .md-typeset .info>summary:before{
     background-color: #3B7EA5;
 }
 
+/* Change the background color of the title and summary of info admonitions */
 .md-typeset .info>.admonition-title, .md-typeset .info>summary{
     background-color: rgba(59, 126, 165, .2) !important;
 }
 
+/* Add transition effect to nav links */
 .md-nav__link[href]{
     transition: .3s all ease;
 }
 
+/* Change the color of nav links on hover */
 .md-nav__link[href]:hover{
     color: #3B7EA5;
     transition: .3s all ease;
 }
 
+/* Change the color and opacity of links in the text */
 .md-typeset a{
     color: #3B7EA5;
     opacity: 1;
     transition: .3s all ease;
 }
+
+/* Change the color and opacity of links in the text on hover */
 .md-typeset a:hover{
     color: #000000;
     opacity: .87;
     transition: .3s all ease;
 }
 
+/* Change the background color of the top element on hover */
 .md-top:hover{
     background-color: #3B7EA5;
 }
 
+/* Change the color of active nav links */
 .md-nav__item .md-nav__link--active{
     color: #3B7EA5 !important;
     transition: .3s all ease;
 }
 
-
+/* Add transition effect and change the opacity and color of tab items */
 .md_tabs__item{
     transition: .3s all ease;
     opacity: .7;
     color: #fff;
 }
 
+/* Change the color and opacity of tab items on hover */
 .md-tabs__item a:hover{
     color: #ccc !important;
     opacity: .7;
     transition: .3s all ease;
 }
 
+/* Change the color of footer links on hover */
 .md-footer__link:hover {
-
     color: #fff !important;
 }
 
+/* Change the background color of the header, tabs, and footer */
 .md-header,
 .md-tabs,
 .md-footer
 {
     background-color: #3B7EA5 !important;
- }
+}
 
+/* Change the background color of the nav title for screens with max-width of 76.234375em */
 @media screen and (max-width: 76.234375em) {
     html [data-md-color-primary=black] .md-nav--primary .md-nav__title[for=__drawer] {
         background-color: #3B7EA5;

From 899cab6adfbd462e9a6484e77925ed20700ff75a Mon Sep 17 00:00:00 2001
From: Tim Friedrich Weber <tfw@satware.com>
Date: Wed, 10 Apr 2024 13:03:49 +0200
Subject: [PATCH 2/2] Improved README.md / documentation

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index a2fa3db..9d377c8 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,34 @@
 This is the source code of our [U.10 Makerspace Worms Homepage](https://u10.makercloud.de)
 
 It is based on the [Open Source Website of the RUB Makerspace](https://makerspace.ruhr-uni-bochum.de/)
+
+## Project Structure and Functions
+
+This project uses [MkDocs](https://www.mkdocs.org/), a fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
+
+### File Structure
+
+- `mkdocs.yml`: The configuration file for the MkDocs project.
+- `docs/`: The directory where all of your documentation is stored in Markdown format.
+    - `aktuelles/`: Contains markdown files for current events and news.
+    - `assets/`: Contains images and other static files.
+    - `bereiche/`: Contains markdown files for different areas of the Makerspace.
+    - `js/`: Contains JavaScript files for custom scripts.
+    - `kontakt/`: Contains markdown files for contact information.
+    - `makerspace_nutzen/`: Contains markdown files for using the Makerspace.
+    - `orga/`: Contains individual markdown files for each team member.
+    - `snippets/`: Contains markdown files for reusable snippets.
+    - `spenden/`: Contains markdown files for donations and sponsors.
+    - `stylesheets/`: Contains CSS files for custom styling.
+  
+    
+- `.gitignore`: Specifies files and directories that should be ignored by Git.
+- `README.md`: The file you're reading right now.
+- `mkdocs.sh`: A shell script to build the MkDocs project locally and start a hot-reload docker environment. Reachable under `http://0.0.0.0:8000/`.
+
+
+- **Local testing**: MkDocs comes with built-in dev-server (started with `./mkdocs.sh`) that lets you preview your documentation as you work on it. Make changes to your `mkdocs.yml` or your docs and MkDocs will automatically update and refresh your browser.
+- **Deployment**: Gitea Actions builds your site and pushes it to the webserver. Push your locally working commit to Gitea and Gitea Actions will do the rest.
+
+
+Remember, the `docs/` directory is where you should place your documentation source files. These files should be written in Markdown.
\ No newline at end of file