feat: use mdBook for documentation (#10)

2025-08-28 23:22:04 +02:00
parent d98cd89c48
commit 3414589bd5
24 changed files with 317 additions and 194 deletions
@@ -0,0 +1,31 @@
+# Summary
+
+[Introduction](README.md)
+
+# User guide
+
+- [Installation](installation.md)
+  - [Linux systemd Service](linux/README.md)
+- [asterctl Tool](asterctl.md)
+- [Shell Commands](shell_commands.md)
+
+# Reference guide
+
+- [Sensor Panels](sensor/panel.md)
+    - [Custom Panel](sensor/custom_panel.md)
+    - [Configuration](sensor/cfg/README.md)
+        - [Text Sensor](sensor/cfg/mode1_text.md)
+        - [Circular Sensor](sensor/cfg/mode2_circular.md)
+        - [Progress Sensor](sensor/cfg/mode3_progress.md)
+        - [Pointer Sensor](sensor/cfg/mode4_pointer.md)
+- [Sensor Value Provider](sensor/provider/README.md)
+    - [Text File Data Source](sensor/provider/text_file.md)
+    - [Shell Scripts](sensor/provider/shell_scripts.md)
+    - [Sysinfo Tool](sensor/provider/sysinfo.md)
+<!--
+- [For developers](for_developers/panel.md)
+-->
+
+# Development
+
+- [LCD Protocol](lcd_protocol.md)