espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-03 00:21:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/esp8684_frontpages' into 'master'

Browse Source 
docs: update frontpage/general pages for ESP8684

Closes IDF-4212

See merge request espressif/esp-idf!16455
This commit is contained in:
Marius Vikhammer
2022-01-04 08:47:42 +00:00
parent 7e39aa61fa 5f7733f692
commit 95c34696c4
8 changed files with 12 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/COPYRIGHT.rst
View File

@@ -86,7 +86,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 <newlib>`, licensed under the BSD License and is Copyright of various parties, as described in :component_file:`COPYING.NEWLIB<newlib/COPYING.NEWLIB>`.

3
docs/en/about.rst
View File

@@ -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 <https://github.com/espressif/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

2
docs/en/contribute/documenting-code.rst
View File

@@ -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 <https://github.com/espressif/esp-docs/blob/master/docs/building-documention.md>`_.
Wrap up
-------

4
docs/en/contribute/install-pre-commit-hook.rst
View File

@@ -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
------------------

2
docs/en/index.rst
View File

@@ -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 <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
.. only:: html

2
docs/en/resources.rst
View File

@@ -19,7 +19,7 @@ Useful Links
* A comprehensive collection of `solutions <https://github.com/espressif/esp-iot-solution#solutions>`_, `practical applications <https://github.com/espressif/esp-iot-solution#esp32-iot-example-list>`_, `components and drivers <https://github.com/espressif/esp-iot-solution#components>`_ based on ESP-IDF is available in `ESP IoT Solution <https://github.com/espressif/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 <https://github.com/espressif/arduino-esp32#readme>`_.
* To develop applications using Arduino platform, refer to `Arduino core for the ESP32, ESP32-S2 and ESP32-C3 <https://github.com/espressif/arduino-esp32#readme>`_.
* Several `books <https://www.espressif.com/en/support/iot-college/books-new>`_ have been written about ESP32 and they are listed on `Espressif <https://www.espressif.com/en/support/iot-college/books-new>`__ web site.