Merge branch 'docs/update_wifi_application_examples' into 'master'

docs: update wifi application examples Closes DOC-3513 See merge request espressif/esp-idf!19673
espressif · Aug 25, 2022 · 409e424 · 409e424
2 parents 935a63e + 7637d24
commit 409e424
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 12 deletions.
diff --git a/docs/en/api-reference/network/esp_wifi.rst b/docs/en/api-reference/network/esp_wifi.rst
@@ -20,11 +20,7 @@ The Wi-Fi libraries provide support for configuring and monitoring the {IDF_TARG
 Application Examples
 --------------------
 
-The :example:`wifi` directory of ESP-IDF examples contains the following applications:
-
-* Code examples for Wi-Fi.
-
-* A simple `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ application to demonstrate a minimal IDF project structure.
+Several application examples demonstrating the functionality of Wi-Fi library are provided in :example:`wifi` directory of ESP-IDF repository. Please check the :example_file:`README <wifi/README.md>` for more details.
 
 
 API Reference

diff --git a/docs/zh_CN/api-reference/network/esp_wifi.rst b/docs/zh_CN/api-reference/network/esp_wifi.rst
@@ -20,11 +20,7 @@ Wi-Fi 库支持配置及监控 {IDF_TARGET_NAME} Wi-Fi 连网功能。支持配
 应用示例
 ----------
 
-ESP-IDF 示例项目的 :example:`wifi` 目录下包含以下应用程序：
-
-* Wi-Fi 示例代码；
-
-* 一个简单的应用程序 `esp-idf-template <https://github.com/espressif/esp-idf-template>`_，展示了最基础的 IDF 项目结构。
+ESP-IDF 仓库的 :example:`wifi` 目录下提供了演示 Wi-Fi 库功能的几个应用示例，请查看 :example_file:`README <wifi/README.md>` 了解更多详细信息。
 
 
 API 参考

diff --git a/examples/wifi/README.md b/examples/wifi/README.md
@@ -7,16 +7,17 @@ This directory contains a range of examples ESP-IDF projects. These are intended
 The examples are grouped into sub-directories by category. Each category directory contains one or more example projects:
 
 * `espnow` is the connectionless Wi-Fi communication protocol.
-* `fast_scan` shows how to use fast scan while connecting to an AP..
+* `fast_scan` shows how to use fast scan while connecting to an AP.
 * `ftm` is a how to use FTM (Fine Timing Measurement) feature to calculate distance between devices.
 * `getting_started` contains the basic examples for using Wi-Fi in STA and AP mode.
 * `iperf` shows the common performance measurements for two ESP running this example.
 * `power_save` contains a how to use power save mode of Wi-Fi.
 * `roaming` contains a example using 802.11k and 802.11v APIs.
 * `scan` shows how to scan for all the available APs.
 * `smart_config` shows how ESP connects to a target AP with ESPTOUCH.
+* `wifi_eap_fast` shows how ESP connects to AP with Wi-Fi enterprise encryption using the EAP-FAST method.
 * `wifi_easy_connect` shows how to configure an ESP device as an enrollee using Device Provisioning Protocol (DPP).
-* `wpa2_enterprise` connects to AP with WPA2 enterprise encryption.
+* `wpa2_enterprise` shows how ESP connects to AP with WPA2 enterprise encryption.
 * `wps` contains a how to use the Wi-Fi Protected Setup protocol.
 
 # More