Added platform-support docs

Signed-off-by: simonmicro <[email protected]>

docs/config.yml

@@ -1,11 +1,12 @@
 # This file is similar to the mkdocs.nav configuration option, but it will be mounted under mkdocs.nav.Firmware only!
 
-- 'OSW-OS':
-  - firmware/getting_started.md
-  - firmware/osw_os.md
-  - firmware/troubleshooting.md
-- 'Applications':
-  - 'Watchfaces': 'firmware/apps/watchfaces.md'
-  - 'Tools': 'firmware/apps/tools.md'
-  - 'Games': 'firmware/apps/games.md'
-  - 'OSW Weather': 'firmware/apps/OswWeather.md'
+- "OSW-OS":
+    - firmware/getting_started.md
+    - firmware/flags.md
+    - firmware/troubleshooting.md
+    - firmware/support.md
+- "Applications":
+    - "Watchfaces": "firmware/apps/watchfaces.md"
+    - "Tools": "firmware/apps/tools.md"
+    - "Games": "firmware/apps/games.md"
+    - "OSW Weather": "firmware/apps/OswWeather.md"

docs/firmware/support.md

@@ -0,0 +1,19 @@
+# Hardware Support
+Over time, the operating system gained additional hardware support for non open-smartwatch environments. This page lists the supported hardware and how to use it (as well as unwanted features, so called "bugs"). You can also find all these configurations inside the `platformio.ini` file.
+
+## Official Hardware
+...based on hardware schematics released by the OSW team and tested frequently.
+
+| Hardware                               | Status       | Reference                                                 |
+| -------------------------------------- | ------------ | --------------------------------------------------------- |
+| `LIGHT_EDITION_V3_3`                   | Maintained   | See "Hardware"-Documentation section                      |
+| `EXPERIMENTAL_LIGHT_EDITION_V4_0`      | Experimental | See "Hardware"-Documentation section                      |
+| `EXPERIMENTAL_LIGHT_EDITION_V3_3_LUA`  | Experimental | Same as `LIGHT_EDITION_V3_3`, but with LUA-script-support |
+| `EXPERIMENTAL_GPS_EDITION_V3_1`        | Experimental | See "Hardware"-Documentation section                      |
+| `EXPERIMENTAL_GPS_EDITION_DEV_ROTATED` | Experimental | See "Hardware"-Documentation section                      |
+
+## 3rd Party Hardware
+
+| Hardware                       | Status       | Reference                         | Known Issues                                                            |
+| ------------------------------ | ------------ | --------------------------------- | ----------------------------------------------------------------------- |
+| `3RD_PARTY_FLOW3R_C3CAMP_2023` | Experimental | [website](https://flow3r.garden/) | [PR368](https://github.com/Open-Smartwatch/open-smartwatch-os/pull/368) |

platformio.ini

@@ -38,6 +38,12 @@ extra_scripts =
 	pre:scripts/build/prebuild_lua.py ; Needed to generate the .cxx file(s), enabled via "OSW_FEATURE_LUA" build flag
 build_unflags = -std=gnu++11 # The correct flag will be set by the cppflags python script...
 
+# ===========================================
+# A note regarding the environments here...
+# If you add new ones, checkout `docs/support.md` and update the list there.
+# If you wonder what flags are available, check the `docs/flags.md` file.
+# ===========================================
+
 [env:MINIMAL] ; For development only, the absolute minimal operating system
 build_flags =
 	-D OSW_TARGET_PLATFORM_HEADER='"platform/MINIMAL.h"'
@@ -53,7 +59,7 @@ build_flags =
 	-D OSW_FEATURE_WIFI
 build_type = debug
 
-[env:LIGHT_EDITION_V4_0]
+[env:EXPERIMENTAL_LIGHT_EDITION_V4_0]
 build_flags =
 	-D OSW_TARGET_PLATFORM_HEADER='"platform/LIGHT_EDITION_V4_0.h"'
 	-D OSW_FEATURE_STATS_STEPS
@@ -63,7 +69,7 @@ build_flags =
 build_type = debug
 
 ; Light edition other stuff
-[env:LIGHT_EDITION_DEV_LUA]
+[env:EXPERIMENTAL_LIGHT_EDITION_V3_3_LUA]
 build_flags =
 	-D OSW_TARGET_PLATFORM_HEADER='"platform/LIGHT_EDITION_V3_3.h"'
 	-D OSW_FEATURE_LUA
@@ -79,7 +85,7 @@ extra_scripts =
 build_type = debug
 
 ; GPS edition by hardware revisions
-[env:GPS_EDITION_V3_1]
+[env:EXPERIMENTAL_GPS_EDITION_V3_1]
 build_flags =
 	-D OSW_TARGET_PLATFORM_HEADER='"platform/GPS_EDITION_V3_1.h"'
 	-D GPS_EDITION
@@ -94,7 +100,7 @@ build_flags =
 build_type = debug
 
 ; GPS edition other stuff
-[env:GPS_EDITION_DEV_ROTATED]
+[env:EXPERIMENTAL_GPS_EDITION_DEV_ROTATED]
 build_flags =
 	-D OSW_TARGET_PLATFORM_HEADER='"platform/GPS_EDITION_V3_1.h"'
 	-D PROGMEM_TILES
@@ -108,11 +114,11 @@ build_flags =
 	-D OSW_FEATURE_WIFI_ONBOOT
 build_type = debug
 
-[env:FLOW3R_C3CAMP_2023]
+[env:3RD_PARTY_FLOW3R_C3CAMP_2023]
 board = esp32-s3-devkitc-1
 build_flags =
 	-D OSW_TARGET_PLATFORM_HEADER='"platform/FLOW3R_C3CAMP_2023.h"'
 	-D OSW_FEATURE_WIFI
 	-D OSW_FEATURE_WIFI_APST
 	-D OSW_FEATURE_WIFI_ONBOOT
-build_type = debug
+build_type = debug