diff --git a/docs/README.md b/docs/README.md index b37423c9..6c95eb32 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,32 +1 @@ -# HASP-LVGL - -## Welcome to the hasp-lvgl documentation. - -### Getting Started - -- Hardware -- Firmware Install -- Inital Setup - -### Configuration - -### Usage - -- Command Reference -- Frequently Asked Questions - -### Design Pages - -- Pages -- Objects -- Styling - -### Demo Layouts - -- Example Pages - -### Firmware Updates - -- ESP32 -- ESP8266 -- STM32F4xx \ No newline at end of file +You can find the documentation on this site: [https://fvanroie.github.io/hasp-lvgl/](https://fvanroie.github.io/hasp-lvgl/) \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 0ec6072d..bf6e0533 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -3,11 +3,6 @@ - **Getting Started** - [Hardware](./01-hardware.md) - - - Display Pinout - - [MHS4001](displays/MHS4001.md) - - [MRB3511](displays/MRB3511.md) - - [Firmware Install](./02-installation.md) - [Initial Setup](./03-wifi-setup.md) @@ -16,15 +11,15 @@ - [Command Reference](./05-commands.md) - [Frequently Asked Questions](./06-faq.md) -- **Configuration** +- **settings** - - [Http](Configuration/30-http.md) - - [Mqtt](Configuration/32-mqtt.md) - - [Hasp](Configuration/33-hasp.md) - - [Wifi](Configuration/34-wifi.md) - - [Display](Configuration/35-display.md) - - [Gpio](Configuration/36-gpio.md) - - [Debug](Configuration/37-debug.md) + - [Http](settings/30-http.md) + - [Mqtt](settings/32-mqtt.md) + - [Hasp](settings/33-hasp.md) + - [Wifi](settings/34-wifi.md) + - [Display](settings/35-display.md) + - [Gpio](settings/36-gpio.md) + - [Debug](settings/37-debug.md) - **Design Pages** @@ -41,4 +36,12 @@ - [ESP32](./38-firmware-esp.md) - [ESP8266](./38-firmware-esp.md) - - [STM32F4xx](./39-firmware-stm32.md) \ No newline at end of file + - [STM32F4xx](./39-firmware-stm32.md) + +- **Hardware** + - Alternate Dev Boards + + - Tested Displays + - [MHS4001](displays/MHS4001.md) + - [WaveShare RPi 4(C)](displays/Waveshare_40RPi_LCD(C).md) + - [MRB3511](displays/MRB3511.md) \ No newline at end of file diff --git a/docs/Configuration/30-http.md b/docs/settings/30-http.md similarity index 100% rename from docs/Configuration/30-http.md rename to docs/settings/30-http.md diff --git a/docs/Configuration/32-mqtt.md b/docs/settings/32-mqtt.md similarity index 100% rename from docs/Configuration/32-mqtt.md rename to docs/settings/32-mqtt.md diff --git a/docs/Configuration/33-hasp.md b/docs/settings/33-hasp.md similarity index 100% rename from docs/Configuration/33-hasp.md rename to docs/settings/33-hasp.md diff --git a/docs/Configuration/34-wifi.md b/docs/settings/34-wifi.md similarity index 100% rename from docs/Configuration/34-wifi.md rename to docs/settings/34-wifi.md diff --git a/docs/Configuration/35-display.md b/docs/settings/35-display.md similarity index 100% rename from docs/Configuration/35-display.md rename to docs/settings/35-display.md diff --git a/docs/Configuration/36-gpio.md b/docs/settings/36-gpio.md similarity index 100% rename from docs/Configuration/36-gpio.md rename to docs/settings/36-gpio.md diff --git a/docs/Configuration/37-debug.md b/docs/settings/37-debug.md similarity index 100% rename from docs/Configuration/37-debug.md rename to docs/settings/37-debug.md diff --git a/docs/Configuration/_sidebar.md b/docs/settings/_sidebar.md similarity index 100% rename from docs/Configuration/_sidebar.md rename to docs/settings/_sidebar.md