From b3de16186062f51121eae2c7d58d6cd6d6bca44b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Barto=C5=A1ka?= <76958047+VojtechBartoska@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:33:38 +0800 Subject: [PATCH] docs_api_note (#9128) --- README.md | 4 ++++ docs/en/libraries.rst | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 09daae01ca0..83b07baedf6 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,10 @@ You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/ --- +**APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is explained [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html#apis).** + +--- + * [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html) * [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html) * [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html) diff --git a/docs/en/libraries.rst b/docs/en/libraries.rst index 37dfad0411b..a3c32b4d6dd 100644 --- a/docs/en/libraries.rst +++ b/docs/en/libraries.rst @@ -71,6 +71,11 @@ APIs The Arduino ESP32 offers some unique APIs, described in this section: +.. note:: + Please be advised that we cannot ensure continuous compatibility between the Arduino Core ESP32 APIs and ESP8266 APIs, as well as Arduino-Core APIs (Arduino.cc). + While our aim is to maintain harmony, the addition of new features may result in occasional divergence. We strive to achieve the best possible integration but acknowledge + that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations. + .. toctree:: :maxdepth: 1 :glob: