From 8a8153219163b689e8f96d6a97c1f128eefd7ce2 Mon Sep 17 00:00:00 2001
From: Gabor Kiss-Vamosi <kisvegabor@gmail.com>
Date: Thu, 17 Mar 2022 13:19:47 +0100
Subject: [PATCH] docs: rearrange the get-started section Add folder for
 Platforms, RTOS, and Bindings

---
 docs/get-started/binding/cpp.md               |  8 ++++++++
 docs/get-started/binding/index.md             | 16 +++++++++++++++
 docs/get-started/{ => binding}/micropython.md |  2 +-
 docs/get-started/index.md                     | 16 ++++-----------
 docs/get-started/os/freertos.md               |  7 +++++++
 docs/get-started/os/index.md                  | 17 ++++++++++++++++
 docs/get-started/{ => os}/nuttx.md            |  2 +-
 docs/get-started/{ => os}/rt-thread.md        |  2 +-
 docs/get-started/os/zephyr.md                 |  7 +++++++
 docs/get-started/{ => platforms}/arduino.md   |  2 +-
 docs/get-started/{ => platforms}/cmake.md     |  2 +-
 docs/get-started/{ => platforms}/espressif.md |  2 +-
 docs/get-started/platforms/index.md           | 20 +++++++++++++++++++
 docs/get-started/{ => platforms}/nxp.md       |  2 +-
 .../{ => platforms}/pc-simulator.md           |  2 +-
 docs/get-started/platforms/stm32.md           |  8 ++++++++
 .../{ => platforms}/tasmota-berry.md          |  2 +-
 docs/get-started/stm32.md                     |  8 --------
 18 files changed, 96 insertions(+), 29 deletions(-)
 create mode 100644 docs/get-started/binding/cpp.md
 create mode 100644 docs/get-started/binding/index.md
 rename docs/get-started/{ => binding}/micropython.md (98%)
 create mode 100644 docs/get-started/os/freertos.md
 create mode 100644 docs/get-started/os/index.md
 rename docs/get-started/{ => os}/nuttx.md (98%)
 rename docs/get-started/{ => os}/rt-thread.md (98%)
 create mode 100644 docs/get-started/os/zephyr.md
 rename docs/get-started/{ => platforms}/arduino.md (98%)
 rename docs/get-started/{ => platforms}/cmake.md (98%)
 rename docs/get-started/{ => platforms}/espressif.md (97%)
 create mode 100644 docs/get-started/platforms/index.md
 rename docs/get-started/{ => platforms}/nxp.md (98%)
 rename docs/get-started/{ => platforms}/pc-simulator.md (98%)
 create mode 100644 docs/get-started/platforms/stm32.md
 rename docs/get-started/{ => platforms}/tasmota-berry.md (98%)
 delete mode 100644 docs/get-started/stm32.md

diff --git a/docs/get-started/binding/cpp.md b/docs/get-started/binding/cpp.md
new file mode 100644
index 000000000..0d451350d
--- /dev/null
+++ b/docs/get-started/binding/cpp.md
@@ -0,0 +1,8 @@
+```eval_rst
+.. include:: /header.rst 
+:github_url: |github_link_base|/get-started/bindings/micropython.md
+```
+#Cpp
+
+In progress: https://github.com/lvgl/lv_binding_cpp
+
diff --git a/docs/get-started/binding/index.md b/docs/get-started/binding/index.md
new file mode 100644
index 000000000..95a8ca412
--- /dev/null
+++ b/docs/get-started/binding/index.md
@@ -0,0 +1,16 @@
+```eval_rst
+.. include:: /header.rst 
+:github_url: |github_link_base|/get-started/bindings/index.md
+```
+# Bindings
+
+
+```eval_rst
+
+.. toctree::
+   :maxdepth: 2
+
+   micropython
+   cpp
+```
+
diff --git a/docs/get-started/micropython.md b/docs/get-started/binding/micropython.md
similarity index 98%
rename from docs/get-started/micropython.md
rename to docs/get-started/binding/micropython.md
index d00d7cd23..395ef948e 100644
--- a/docs/get-started/micropython.md
+++ b/docs/get-started/binding/micropython.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/micropython.md
+:github_url: |github_link_base|/get-started/bindings/micropython.md
 ```
 # Micropython
 
diff --git a/docs/get-started/index.md b/docs/get-started/index.md
index f95c0cc4b..1f7493b69 100644
--- a/docs/get-started/index.md
+++ b/docs/get-started/index.md
@@ -8,7 +8,7 @@ There are several ways to get your feet wet with LVGL. Here is one recommended o
 1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
 2. Read the [Introduction](https://docs.lvgl.io/latest/en/html/intro/index.html) page of the documentation (5 minutes)
 3. Read the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page of the documentation (15 minutes)
-4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/pc-simulator.html) (10 minutes)
+4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/platforms/pc-simulator.html) (10 minutes)
 5. Try out some [Examples](https://docs.lvgl.io/master/examples.html)
 6. Check out the Platform-specific tutorials. (in this section below). (10 minutes) 
 7. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_&type=&language=)
@@ -23,16 +23,8 @@ There are several ways to get your feet wet with LVGL. Here is one recommended o
 .. toctree::
    :maxdepth: 2
 
-   quick-overview
-   pc-simulator
-   stm32
-   nxp
-   espressif
-   arduino
-   micropython
-   tasmota-berry
-   nuttx
-   rt-thread
-   cmake
+   platforms/index
+   os/index
+   bindings/index
 ```
 
diff --git a/docs/get-started/os/freertos.md b/docs/get-started/os/freertos.md
new file mode 100644
index 000000000..0cc6d4519
--- /dev/null
+++ b/docs/get-started/os/freertos.md
@@ -0,0 +1,7 @@
+```eval_rst
+.. include:: /header.rst
+:github_url: |github_link_base|/get-started/os/freertos.md
+```
+# FreeRTOS
+
+TODO
\ No newline at end of file
diff --git a/docs/get-started/os/index.md b/docs/get-started/os/index.md
new file mode 100644
index 000000000..21c06bb54
--- /dev/null
+++ b/docs/get-started/os/index.md
@@ -0,0 +1,17 @@
+```eval_rst
+.. include:: /header.rst 
+:github_url: |github_link_base|/get-started/os/index.md
+```
+# (RT)OS
+
+```eval_rst
+
+.. toctree::
+   :maxdepth: 2
+
+   nuttx
+   rt-thread
+   freertos
+   zephyr
+```
+
diff --git a/docs/get-started/nuttx.md b/docs/get-started/os/nuttx.md
similarity index 98%
rename from docs/get-started/nuttx.md
rename to docs/get-started/os/nuttx.md
index 02d26e956..7b8f4721f 100644
--- a/docs/get-started/nuttx.md
+++ b/docs/get-started/os/nuttx.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/nuttx.md
+:github_url: |github_link_base|/get-started/os/nuttx.md
 ```
 # NuttX RTOS
 
diff --git a/docs/get-started/rt-thread.md b/docs/get-started/os/rt-thread.md
similarity index 98%
rename from docs/get-started/rt-thread.md
rename to docs/get-started/os/rt-thread.md
index 0e57f4916..aa4dcf4eb 100644
--- a/docs/get-started/rt-thread.md
+++ b/docs/get-started/os/rt-thread.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst
-:github_url: |github_link_base|/get-started/rt-thread.md
+:github_url: |github_link_base|/get-started/os/rt-thread.md
 ```
 # RT-Thread RTOS
 
diff --git a/docs/get-started/os/zephyr.md b/docs/get-started/os/zephyr.md
new file mode 100644
index 000000000..996775d5a
--- /dev/null
+++ b/docs/get-started/os/zephyr.md
@@ -0,0 +1,7 @@
+```eval_rst
+.. include:: /header.rst
+:github_url: |github_link_base|/get-started/os/zephyr.md
+```
+# FreeRTOS
+
+TODO
\ No newline at end of file
diff --git a/docs/get-started/arduino.md b/docs/get-started/platforms/arduino.md
similarity index 98%
rename from docs/get-started/arduino.md
rename to docs/get-started/platforms/arduino.md
index 4360b2329..1a556d175 100644
--- a/docs/get-started/arduino.md
+++ b/docs/get-started/platforms/arduino.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/arduino.md
+:github_url: |github_link_base|/get-started/platforms/arduino.md
 ```
 
 # Arduino
diff --git a/docs/get-started/cmake.md b/docs/get-started/platforms/cmake.md
similarity index 98%
rename from docs/get-started/cmake.md
rename to docs/get-started/platforms/cmake.md
index a79404dad..997cf2c00 100644
--- a/docs/get-started/cmake.md
+++ b/docs/get-started/platforms/cmake.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/cmake.md
+:github_url: |github_link_base|/get-started/platforms/cmake.md
 ```
 
 # CMake
diff --git a/docs/get-started/espressif.md b/docs/get-started/platforms/espressif.md
similarity index 97%
rename from docs/get-started/espressif.md
rename to docs/get-started/platforms/espressif.md
index afd2d4a11..228f72dba 100644
--- a/docs/get-started/espressif.md
+++ b/docs/get-started/platforms/espressif.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/espressif.md
+:github_url: |github_link_base|/get-started/platforms/espressif.md
 ```
 
 # Espressif (ESP32 chip series)
diff --git a/docs/get-started/platforms/index.md b/docs/get-started/platforms/index.md
new file mode 100644
index 000000000..4ac7106ea
--- /dev/null
+++ b/docs/get-started/platforms/index.md
@@ -0,0 +1,20 @@
+```eval_rst
+.. include:: /header.rst 
+:github_url: |github_link_base|/get-started/index.md
+```
+# Platforms
+
+```eval_rst
+
+.. toctree::
+   :maxdepth: 2
+
+   pc-simulator
+   stm32
+   nxp
+   espressif
+   arduino
+   tasmota-berry
+   cmake
+```
+
diff --git a/docs/get-started/nxp.md b/docs/get-started/platforms/nxp.md
similarity index 98%
rename from docs/get-started/nxp.md
rename to docs/get-started/platforms/nxp.md
index 82e52ff98..b2fe1979d 100644
--- a/docs/get-started/nxp.md
+++ b/docs/get-started/platforms/nxp.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst
-:github_url: |github_link_base|/get-started/nxp.md
+:github_url: |github_link_base|/get-started/platforms/nxp.md
 ```
 # NXP
 NXP has integrated LVGL into the MCUXpresso SDK packages for several of their general
diff --git a/docs/get-started/pc-simulator.md b/docs/get-started/platforms/pc-simulator.md
similarity index 98%
rename from docs/get-started/pc-simulator.md
rename to docs/get-started/platforms/pc-simulator.md
index 261c0be32..a309e9a73 100644
--- a/docs/get-started/pc-simulator.md
+++ b/docs/get-started/platforms/pc-simulator.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/pc-simulator.md
+:github_url: |github_link_base|/get-started/platoforms/simulator.md
 ```
 # Simulator on PC
 
diff --git a/docs/get-started/platforms/stm32.md b/docs/get-started/platforms/stm32.md
new file mode 100644
index 000000000..f7dffb90c
--- /dev/null
+++ b/docs/get-started/platforms/stm32.md
@@ -0,0 +1,8 @@
+```eval_rst
+.. include:: /header.rst 
+:github_url: |github_link_base|/get-started/platforms/stm32.md
+```
+
+# STM32
+
+TODO
diff --git a/docs/get-started/tasmota-berry.md b/docs/get-started/platforms/tasmota-berry.md
similarity index 98%
rename from docs/get-started/tasmota-berry.md
rename to docs/get-started/platforms/tasmota-berry.md
index b7ee45a45..e4543bc1c 100644
--- a/docs/get-started/tasmota-berry.md
+++ b/docs/get-started/platforms/tasmota-berry.md
@@ -1,6 +1,6 @@
 ```eval_rst
 .. include:: /header.rst 
-:github_url: |github_link_base|/get-started/tasmota-berry.md
+:github_url: |github_link_base|/get-started/platforms/tasmota-berry.md
 ```
 # Tasmota and berry
 
diff --git a/docs/get-started/stm32.md b/docs/get-started/stm32.md
deleted file mode 100644
index 28b3a9ca9..000000000
--- a/docs/get-started/stm32.md
+++ /dev/null
@@ -1,8 +0,0 @@
-```eval_rst
-.. include:: /header.rst 
-:github_url: |github_link_base|/get-started/stm32.md
-```
-
-# STM32
-
-TODO