Add EZAuth Logo

Add Documentation Pages

README.md

@@ -1,4 +1,4 @@
-<img src="assets/ezauth_banner.png" />
+<img src="docs/ezauth_banner.png" />
 
 <h3 align="center">High performance self-hosted and fully customizable authentication service</h3>
 
@@ -9,4 +9,4 @@
 - ⚠️ Make sure to always have a backup of your user data.
 
 > [!NOTE]
-> The Documentation is still in progress.
+> You can find the Documentation [here](https://johngrubba.github.io/ezauth/)

docs/getting-started/configuration.md

@@ -0,0 +1 @@
+# Configuration

docs/getting-started/setup.md

@@ -0,0 +1 @@
+# Setup / Installation

docs/index.md

@@ -1,17 +1,17 @@
-# Welcome to MkDocs
+<img src="ezauth_banner.png" />
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+<h3 align="center">High performance self-hosted and fully customizable authentication service</h3>
 
-## Commands
+## Disclaimer
 
-* `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.
+- ⚠️ The project is under **very active** development.
+- ⚠️ Expect bugs and breaking changes.
+- ⚠️ Make sure to always have a backup of your user data.
 
-## Project layout
+## Features
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+- **High performance**: Written in Python with the help of FastAPI.
+- **Customizable**: You can customize the service to your needs.
+- **Self-hosted**: You have full control over your user data.
+- **Secure**: The service is designed with security in mind.
+- **Easy to use**: The service is easy to set up and use.

mkdocs.yml

@@ -3,26 +3,13 @@ site_description: EZAuth is a high performance self-hosted and fully customizabl
 use_directory_urls: True
 repo_url: https://github.com/JohnGrubba/ezauth
 nav:
-    - Home: index.md
-    - Quickstart with Docker: docker_quickstart.md
-    - Installation:
-        - Linux/MacOS/Raspberry: installation.md
-        - Windows: windows_installation.md
-    - Freqtrade Basics: bot-basics.md
-    - Configuration: configuration.md
-    - Strategy Customization: strategy-customization.md
-    - Strategy Callbacks: strategy-callbacks.md
-    - Stoploss: stoploss.md
-    - Plugins: plugins.md
-    - Start the bot: bot-usage.md
-    - Control the bot:
-        - Telegram: telegram-usage.md
-        - freqUI: freq-ui.md
-        - REST API: rest-api.md
-        - Web Hook: webhook-config.md
+  - Home: index.md
+  - Getting Started:
+    - Installation / Setup: getting-started/setup.md
+    - Configuration: getting-started/configuration.md
 theme:
   name: material
-  logo: "ezauth_banner.png"
+  logo: "ezauth_logo.png"
   features:
     - content.code.annotate
     - search.share
@@ -31,15 +18,16 @@ theme:
     - navigation.footer
   language: en
   palette:
-    - scheme: default
-      primary: "blue grey"
-      accent: "tear"
+    - media: "(prefers-color-scheme: light)"
+      scheme: default 
+      primary: blue
       toggle:
-        icon: material/toggle-switch-off-outline
+        icon: material/weather-night
         name: Switch to dark mode
-    - scheme: slate
-      primary: "blue grey"
-      accent: "tear"
+
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue
       toggle:
-        icon: material/toggle-switch
-        name: Switch to light mode
+        icon: material/weather-sunny
+        name: Switch to system preference