Improved documentation structure (#465)

Signed-off-by: Lukas Frank <lukas.frank@sap.com>
ironcore-dev · Dec 18, 2024 · 716865e · 716865e
1 parent 7020fad
commit 716865e
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 4 deletions.
diff --git a/docs/architecture/README.md → docs/architecture.md b/docs/architecture/README.md → docs/architecture.md
diff --git a/docs/concepts/console.md b/docs/concepts/console.md
@@ -0,0 +1 @@
+# Console
diff --git a/docs/concepts/events.md b/docs/concepts/events.md
@@ -0,0 +1 @@
+# Machine Events
diff --git a/docs/concepts/plugins/nic.md b/docs/concepts/plugins/nic.md
@@ -0,0 +1 @@
+# Networkinterface Plugins
diff --git a/docs/concepts/plugins/volume.md b/docs/concepts/plugins/volume.md
@@ -0,0 +1 @@
+# Volume Plugins
diff --git a/docs/development/dev_docs.md b/docs/development/dev_docs.md
@@ -0,0 +1,15 @@
+# libvirt-provider documentation
+
+## Local dev setup
+
+You can run the documentation via:
+
+```shell
+make start-docs
+```
+
+You can remove the `mkdocs` container image by running:
+
+```shell
+make clean-docs
+```
diff --git a/docs/development/setup.md → docs/development/dev_setup.md b/docs/development/setup.md → docs/development/dev_setup.md
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1 @@
+# Usage
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -48,10 +48,17 @@ markdown_extensions:
 
 nav:
   - Home: README.md
-  - Architecture:
-    - architecture/README.md
-  - Main Documentation ⧉: https://ironcore-dev.github.io/documentation/
-  - Landing Page ⧉: https://ironcore-dev.github.io/
+  - Architecture: architecture.md
+  - Concepts:
+      - Console: concepts/console.md
+      - Events: concepts/events.md
+      - Plugins:
+        - NIC: concepts/plugins/nic.md
+        - Volume: concepts/plugins/volume.md
+  - Usage: usage.md
+  - Development Guide:
+      - Local Setup: development/dev_setup.md
+      - Documentation: development/dev_docs.md
 
 extra:
   social: