From 2aedcb9c6549f87d1826825232a251fa54bbd49d Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz Date: Wed, 27 Sep 2023 12:04:54 -0300 Subject: [PATCH] Documentation - Update supported IDEs and general improvements --- docs/source/installing.rst | 2 ++ docs/source/ota_web_update.rst | 3 +++ 2 files changed, 5 insertions(+) diff --git a/docs/source/installing.rst b/docs/source/installing.rst index c3bd268949b..9ad97e1d14c 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -73,6 +73,8 @@ Installing using PlatformIO PlatformIO is a professional collaborative platform for embedded development. It has out-of-the-box support for ESP32 SoCs and allows working with Arduino ESP32 as well as ESP-IDF from Espressif without changing your development environment. PlatformIO includes lots of instruments for the most common development tasks such as debugging, unit testing, and static code analysis. +.. warning:: PlatformIO is not officially supported by Espressif. Please report any issues with PlatformIO directly to its developers `the official PlatformIO repositories `_. + A detailed overview of the PlatformIO ecosystem and its philosophy can be found in `the official documentation `_. PlatformIO can be used in two flavors: diff --git a/docs/source/ota_web_update.rst b/docs/source/ota_web_update.rst index b637f0206b3..be0a6d5e263 100644 --- a/docs/source/ota_web_update.rst +++ b/docs/source/ota_web_update.rst @@ -8,6 +8,9 @@ OTAWebUpdate is done with a web browser that can be useful in the following typi - after deployment if user is unable to expose Firmware for OTA from external update server - provide updates after deployment to small quantity of modules when setting an update server is not practicable +For more information about the update process, please refer to the `OTA API reference `_ +section of the ESP-IDF documentation. + Requirements ------------