From 69203400f0ebc0a7aed9e533be6cd8f42465bb33 Mon Sep 17 00:00:00 2001 From: Shubham Patil Date: Wed, 10 Aug 2022 11:07:23 +0530 Subject: [PATCH] [ESP32] Fix links to common docs in example readmes (#21754) * [ESP32] Fix links to common docs in example readmes * restyle * Some nitpicks * remove unused bullet --- docs/guides/esp32/setup_idf_chip.md | 5 +++++ examples/all-clusters-app/esp32/README.md | 17 +++++++---------- examples/bridge-app/esp32/README.md | 7 ++++--- examples/light-switch-app/esp32/README.md | 7 ++++--- examples/lighting-app/esp32/README.md | 11 +++++------ examples/lock-app/esp32/README.md | 11 +++++------ examples/ota-provider-app/esp32/README.md | 9 ++++----- examples/ota-requestor-app/esp32/README.md | 11 +++++------ examples/persistent-storage/esp32/README.md | 7 ++++--- examples/pigweed-app/esp32/README.md | 7 ++++--- .../temperature-measurement-app/esp32/README.md | 7 ++++--- 11 files changed, 51 insertions(+), 48 deletions(-) diff --git a/docs/guides/esp32/setup_idf_chip.md b/docs/guides/esp32/setup_idf_chip.md index afd5e0618fa6a2..cffc57f539c974 100644 --- a/docs/guides/esp32/setup_idf_chip.md +++ b/docs/guides/esp32/setup_idf_chip.md @@ -74,3 +74,8 @@ running: ``` source scripts/bootstrap.sh ``` + +--- + +Once IDF and CHIP environment is set up, head over to +[application building and commissioning guide](build_app_and_commission.md). diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index eca32dbf28638b..6cb3f9093da13b 100644 --- a/examples/all-clusters-app/esp32/README.md +++ b/examples/all-clusters-app/esp32/README.md @@ -3,20 +3,17 @@ A prototype application that demonstrates device commissioning and cluster control. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- - [Cluster control](#cluster-control) -- [Note](#note) -- Please refer [Matter OTA guide](../../../docs/guides/esp32/ota.md) for - trying out OTA -- Please refer - [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md) - for using RPC and device tracing +- [Matter OTA guide](../../../docs/guides/esp32/ota.md) +- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md) --- @@ -40,7 +37,7 @@ Usage: $ ./out/debug/chip-tool levelcontrol move-to-level Level=10 TransitionTime=0 OptionMask=0 OptionOverride=0 ``` -### Note +--- This demo app illustrates controlling OnOff cluster (Server) attributes of an endpoint. For `ESP32-DevKitC`, `ESP32-WROVER-KIT_V4.1` and `ESP32C3-DevKitM`, a diff --git a/examples/bridge-app/esp32/README.md b/examples/bridge-app/esp32/README.md index 9c05601b560512..5a5e57c960cc7d 100644 --- a/examples/bridge-app/esp32/README.md +++ b/examples/bridge-app/esp32/README.md @@ -1,8 +1,9 @@ # CHIP ESP32 Bridge App Example -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- diff --git a/examples/light-switch-app/esp32/README.md b/examples/light-switch-app/esp32/README.md index b02399d5b6af96..43a9d9536b75db 100644 --- a/examples/light-switch-app/esp32/README.md +++ b/examples/light-switch-app/esp32/README.md @@ -2,9 +2,10 @@ This example demonstrates the Matter Light-switch application on ESP platforms. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- diff --git a/examples/lighting-app/esp32/README.md b/examples/lighting-app/esp32/README.md index 74d14429eaf857..b84deeaf9d3fbd 100644 --- a/examples/lighting-app/esp32/README.md +++ b/examples/lighting-app/esp32/README.md @@ -2,17 +2,16 @@ This example demonstrates the Matter Lighting application on ESP platforms. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- - [Cluster Control](#cluster-control) -- [Steps to Try Lighting app OTA Requestor](#steps-to-try-lighting-app-ota-requestor) -- Please check [Matter OTA guide](../../../docs/guides/esp32/ota.md) for - trying out OTA +- [Matter OTA guide](../../../docs/guides/esp32/ota.md) --- diff --git a/examples/lock-app/esp32/README.md b/examples/lock-app/esp32/README.md index f57b70b9d2e5cd..0cf5c00c184644 100644 --- a/examples/lock-app/esp32/README.md +++ b/examples/lock-app/esp32/README.md @@ -2,18 +2,17 @@ This example demonstrates the mapping of OnOff cluster to lock/unlock logic. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- - [Cluster control](#cluster-control) - [Example Demo](#example-demo) -- Please refer - [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md) - for using RPC and device tracing +- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md) --- diff --git a/examples/ota-provider-app/esp32/README.md b/examples/ota-provider-app/esp32/README.md index 8c804a2e8840dc..aa2ead1d25816b 100644 --- a/examples/ota-provider-app/esp32/README.md +++ b/examples/ota-provider-app/esp32/README.md @@ -2,19 +2,18 @@ A prototype application that demonstrates OTA provider capabilities. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) guide -to get started. +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) --- -- [Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +- [Building and Commissioning](#building-and-commissioning) - [Access control list requirements](#access-control-list-requirements) - [Set delayed action time (Optional)](#set-delayed-action-time-optional) --- -### Build, Flash, Monitor, and Commissioning +### Building and Commissioning Generate the OTA image as described [here](../../../docs/guides/esp32/ota.md#generate-chip-ota-image) diff --git a/examples/ota-requestor-app/esp32/README.md b/examples/ota-requestor-app/esp32/README.md index 28c44be76396b9..ac61c1ecde8be0 100644 --- a/examples/ota-requestor-app/esp32/README.md +++ b/examples/ota-requestor-app/esp32/README.md @@ -2,9 +2,10 @@ A prototype application that demonstrates OTA Requestor capabilities. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- @@ -13,9 +14,7 @@ guides to get started. - [Query for an OTA Image](#query-for-an-ota-image) - [ESP32 OTA Requestor with Linux OTA Provider](#esp32-ota-requestor-with-linux-ota-provider) - [Generate OTA image](#generate-ota-image) -- Please refer - [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md) - for using RPC and device tracing +- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md) --- diff --git a/examples/persistent-storage/esp32/README.md b/examples/persistent-storage/esp32/README.md index 2217c6f66ced22..d87b894060af13 100644 --- a/examples/persistent-storage/esp32/README.md +++ b/examples/persistent-storage/esp32/README.md @@ -2,9 +2,10 @@ An example testing and demonstrating the key value storage API. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- diff --git a/examples/pigweed-app/esp32/README.md b/examples/pigweed-app/esp32/README.md index ad4d6b2c167e96..8044faebd14bb0 100644 --- a/examples/pigweed-app/esp32/README.md +++ b/examples/pigweed-app/esp32/README.md @@ -1,8 +1,9 @@ # CHIP ESP32 Pigweed Example Application -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. --- diff --git a/examples/temperature-measurement-app/esp32/README.md b/examples/temperature-measurement-app/esp32/README.md index 43c377e5c0cbbd..d89c12dada8800 100644 --- a/examples/temperature-measurement-app/esp32/README.md +++ b/examples/temperature-measurement-app/esp32/README.md @@ -2,9 +2,10 @@ This example is meant to represent a minimal-sized application. -Refer to -[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and -[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning) +Please +[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md) +and refer +[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. ---