From 8be475d01013a8c6fd0fee7fca060bfe1fcad1e0 Mon Sep 17 00:00:00 2001
From: CaCO3 <caco@ruinelli.ch>
Date: Mon, 2 Jan 2023 23:21:38 +0100
Subject: [PATCH] .

---
 .gitignore   |  1 +
 README.md    | 34 ++++++++++++++++++++++++++++++++++
 docs/nav.yml |  6 +++---
 3 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d97e100
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+site
\ No newline at end of file
diff --git a/README.md b/README.md
index 62f0225..bf1f4b2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,36 @@
 # AI-on-the-edge-device-docs
  
+This repo contains the documentation for the [AI-on-the-Edge-Device Project](https://github.com/jomjol/AI-on-the-edge-device).
+
+# How does it work
+1. You can edit any `*.md` document in the `docs` folder.
+1. Then create a Pull Request for it to merge it into the `main` branch.
+1. When it got merged, the Github Actions will re-generate the documentation and place it in the `gh-pages` branch. This branch automatically gets populated to the public [Documentation Site](https://jomjol.github.io/AI-on-the-edge-device-docs)
+
+## Migrating existing Wiki Pages
+The files from the [AI-on-the-Edge-Device Wiki](https://github.com/jomjol/AI-on-the-edge-device/wiki) got exported and added to this repo. Unless the files are listed in the [nav.yml](nav.yml) file, they will be listed in the **asorted pages** section.
+We should review all pages from there step by step and add them to the navigation.
+
+Tasks to do:
+ - Check links
+ - Fetch included images and place them directly in the `docs/img` folder
+ - Rerwrite to have a clear structure
+
+
+## Adding new files
+1. Add a new `*.md` document in the `docs` folder.
+1. Add the **filename** to the `nav.yml` at the position you want to have the document in the navigation in the sidebar on the left.
+
+## Local Test
+To test it locally:
+1. Clone this repo
+1. Install the required tools:
+    ```
+    pip install --upgrade pip
+    pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin
+    ```
+1. In the main folder of the repo, call `mkdocs serve` (and keep it running).
+  This will locally generate the documentation.
+  You can access it under http://127.0.0.1:8000/AI-on-the-edge-device-docs/
+
+    Any change to the files will automatically be applied.
\ No newline at end of file
diff --git a/docs/nav.yml b/docs/nav.yml
index e8726a5..c6f7b0d 100644
--- a/docs/nav.yml
+++ b/docs/nav.yml
@@ -7,10 +7,10 @@ nav:
 
   - Links:
     - Web Installer/Console: https://jomjol.github.io/AI-on-the-edge-device/index.html
-    - Issues: https://github.com/jomjol/AI-on-the-edge-device/issues
-    - Discussions: https://github.com/jomjol/AI-on-the-edge-device/discussions
+    - Place an Issues: https://github.com/jomjol/AI-on-the-edge-device/issues
+    - Join a Discussions: https://github.com/jomjol/AI-on-the-edge-device/discussions
 
   - Asorted Pages:
     # List all pages which are not covered by above list
-    # Step by step we should migrate those page to above list
+    # Step by step we should migrate those page to the above list
     - ...