diff --git a/docs/TEMPLATE_EXAMPLE_README.md b/docs/TEMPLATE_EXAMPLE_README.md index 06b558028e..ffe0beb9d7 100644 --- a/docs/TEMPLATE_EXAMPLE_README.md +++ b/docs/TEMPLATE_EXAMPLE_README.md @@ -1,5 +1,9 @@ _Note that this is a template for an ESP-IDF example README.md file. When using this template, replace all these emphasised placeholders with example-specific content._ +| Supported Targets | _Supported target, e.g. ESP32_ | _Another supported target, e.g. ESP32-S3_ | +| ----------------- | ------------------------------ | ----------------------------------------- | + +_If the example supports all targets supported by ESP-IDF then the table can be omitted_ # _Example Title_ (See the README.md file in the upper level 'examples' directory for more information about examples.) diff --git a/docs/docs_not_updated/esp8684.txt b/docs/docs_not_updated/esp8684.txt index f3abea91d7..b436594b2f 100644 --- a/docs/docs_not_updated/esp8684.txt +++ b/docs/docs_not_updated/esp8684.txt @@ -1,11 +1,3 @@ -languages -contribute/contributor-agreement -contribute/documenting-code -contribute/creating-examples -contribute/style-guide -contribute/copyright-guide -contribute/install-pre-commit-hook -contribute/index api-guides/core_dump_internals api-guides/event-handling api-guides/performance/speed @@ -74,13 +66,6 @@ api-guides/fatal-errors api-guides/memory-types api-guides/build-system-legacy api-guides/general-notes -third-party-tools/platformio -COPYRIGHT -libraries-and-frameworks/libs-frameworks -libraries-and-frameworks/index -libraries-and-frameworks/cloud-frameworks -versions -gnu-make-legacy api-reference/api-conventions api-reference/template api-reference/provisioning/protocomm @@ -217,8 +202,6 @@ api-reference/protocols/index api-reference/protocols/asio security/flash-encryption security/secure-boot-v2 -about -resources get-started/establish-serial-connection get-started/macos-setup-scratch get-started/vscode-setup @@ -231,4 +214,3 @@ get-started/linux-setup get-started/index get-started/windows-setup-update get-started/macos-setup -index diff --git a/docs/en/COPYRIGHT.rst b/docs/en/COPYRIGHT.rst index e2af466fc7..2f9eccdd08 100644 --- a/docs/en/COPYRIGHT.rst +++ b/docs/en/COPYRIGHT.rst @@ -84,7 +84,7 @@ Documentation ROM Source Code Copyrights ========================== -ESP32, ESP32-S and ESP32-C Series SoCs mask ROM hardware includes binaries compiled from portions of the following third party software: +ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs mask ROM hardware includes binaries compiled from portions of the following third party software: * :component:`Newlib `, licensed under the BSD License and is Copyright of various parties, as described in :component_file:`COPYING.NEWLIB`. diff --git a/docs/en/about.rst b/docs/en/about.rst index f37606ebcf..7f0aa59403 100644 --- a/docs/en/about.rst +++ b/docs/en/about.rst @@ -23,12 +23,13 @@ About The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a Xtensa® 32-bit LX7 CPU. -.. only:: esp32c3 +.. only:: esp32c3 or esp8684 This is documentation of `ESP-IDF `_, the framework to develop applications for {IDF_TARGET_NAME}. The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a 32-bit RISC-V RV32IMC single-core processor. + .. figure:: ../_static/about-doc.png :align: center :alt: Espressif IoT Integrated Development Framework diff --git a/docs/en/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst index 98c9504f67..5c2271fbb5 100644 --- a/docs/en/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -183,7 +183,7 @@ or for specific target and language with:: build-docs -t esp32 -l en build -For more in-depth documentation about `esp-docs` features please see the `esp-doc` documentation. +For more in-depth documentation about `esp-docs` features please see the documentation in the `esp-docs repository `_. Wrap up ------- diff --git a/docs/en/contribute/install-pre-commit-hook.rst b/docs/en/contribute/install-pre-commit-hook.rst index 61d867a837..688ad5cc76 100644 --- a/docs/en/contribute/install-pre-commit-hook.rst +++ b/docs/en/contribute/install-pre-commit-hook.rst @@ -4,9 +4,9 @@ Install pre-commit Hook for ESP-IDF Project Required Dependency ------------------- -Python 3.6.1 or above. This is our recommendation python version for IDF developers. +Python 3.6.1 or above. This is our recommended python version for IDF developers. -If you still have python versions not compatible, please do not install pre-commit hook and update your python versions. +If you still have python versions not compatible, update your python versions before installing the pre-commit hook. Install pre-commit ------------------ diff --git a/docs/en/index.rst b/docs/en/index.rst index 023562e9b9..5c893cbe35 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -8,7 +8,7 @@ ESP-IDF Programming Guide The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation. -This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs `_. +This is the documentation for Espressif IoT Development Framework (`esp-idf `_). ESP-IDF is the official development framework for the `ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs `_. .. only:: html diff --git a/docs/en/resources.rst b/docs/en/resources.rst index 33fd93e3e4..d412688b52 100644 --- a/docs/en/resources.rst +++ b/docs/en/resources.rst @@ -19,7 +19,7 @@ Useful Links * A comprehensive collection of `solutions `_, `practical applications `_, `components and drivers `_ based on ESP-IDF is available in `ESP IoT Solution `_ repository. In most of cases descriptions are provided both in English and in 中文. -* To develop applications using Arduino platform, refer to `Arduino core for ESP32 WiFi chip `_. +* To develop applications using Arduino platform, refer to `Arduino core for the ESP32, ESP32-S2 and ESP32-C3 `_. * Several `books `_ have been written about ESP32 and they are listed on `Espressif `__ web site.