docs: theming setup

Author: mhaeming

.github/workflows/create_release.yml

@@ -5,6 +5,9 @@ on:
     tags:
       - v*
 
+permissions:
+  contents: write
+
 jobs:
   release_build:
     runs-on: ubuntu-latest

.gitignore

@@ -31,3 +31,5 @@ google-services.json
 
 # Android Profiling
 *.hprof
+
+site

README.md

@@ -2,7 +2,23 @@
 
 This is the code repository for the Android app developed in the studyproject Sensory augmentation and grasping movements.
 
-![Debug APK Builds](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/debug_build.yml/badge.svg)
+[![Testing APK](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/debug_build.yml/badge.svg)](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/debug_build.yml)
+
+# Roadmap
+
+```mermaid
+	gitGraph LR:
+		commit id: "Current state"
+		commit id: "Workgroup Release" tag: "v0.0.1"
+		commit id: "Run example tensorflow model"
+		commit id: "Feedback round with experimental group"
+		commit id: "Integrate feedback"  tag: "v0.0.2"
+		commit id: "Christmas break"
+		commit id: "Object detection via any image input"
+		commit id: "Polishing"
+		commit id: "Optivist Presentation" tag: "v0.0.3"
+		commit id: "Prepare for codebase transfer"
+```
 
 # Documentation
 

docs/architecture/overview.md

@@ -1 +1,18 @@
-# How is our app structured?
+# How is our app structured?
+
+```mermaid
+flowchart
+	subgraph activities
+	m[MainActivity]
+	m --> GroceryListActivity
+	m --> PlaceActivity
+	m --> SettingsActivity
+	
+	end
+	subgraph utilities
+	TextToSpeechUtility
+	SpeechToTextButton
+	SpeechToTextUtility
+	
+	end
+```

docs/images/favicon.png

@@ -1,17 +1,3 @@
 # Overview
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+Welcome to the documentation of NLInterface Project!

docs/index.md

@@ -2,12 +2,59 @@ site_name: NLInterface
 site_url: ""
 use_directory_urls: false
 
+repo_name: NLInterface
+repo_url: https://github.com/StudyProject-NLI/NLInterface
+
+
 theme:
   name: "material"
   highlightjs: true
   hljs_languages:
     - bash
     - kotlin
+  favicon: images/favicon.png
+  logo: images/favicon.png
+  icon:
+    repo: fontawesome/brands/github
+
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+  features:
+    - search.suggest
+
 
 markdown_extensions:
-  - admonition
+- attr_list
+- md_in_html
+- admonition
+- pymdownx.inlinehilite
+- pymdownx.details
+- pymdownx.snippets
+- pymdownx.superfences:
+    custom_fences:
+      - name: mermaid
+        class: mermaid
+        format: !!python/name:pymdownx.superfences.fence_code_format
+
+plugins:
+  - offline
+  - search