Skip to content

Commit 397d642

Browse files
shubhamdpshubhamdp
authored
[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
1 parent 9b85c7a commit 397d642

File tree

11 files changed

+51
-48
lines changed

11 files changed

+51
-48
lines changed

‎docs/guides/esp32/setup_idf_chip.md

+5
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,8 @@ running:
7474
```
7575
source scripts/bootstrap.sh
7676
```
77+
78+
---
79+
80+
Once IDF and CHIP environment is set up, head over to
81+
[application building and commissioning guide](build_app_and_commission.md).

‎examples/all-clusters-app/esp32/README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,17 @@
33
A prototype application that demonstrates device commissioning and cluster
44
control.
55

6-
Refer to
7-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
8-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
6+
Please
7+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
8+
and refer
9+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
910
guides to get started.
1011

1112
---
1213

1314
- [Cluster control](#cluster-control)
14-
- [Note](#note)
15-
- Please refer [Matter OTA guide](../../../docs/guides/esp32/ota.md) for
16-
trying out OTA
17-
- Please refer
18-
[RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
19-
for using RPC and device tracing
15+
- [Matter OTA guide](../../../docs/guides/esp32/ota.md)
16+
- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
2017

2118
---
2219

@@ -40,7 +37,7 @@ Usage:
4037
$ ./out/debug/chip-tool levelcontrol move-to-level Level=10 TransitionTime=0 OptionMask=0 OptionOverride=0 <NODE ID> <ENDPOINT>
4138
```
4239

43-
### Note
40+
---
4441

4542
This demo app illustrates controlling OnOff cluster (Server) attributes of an
4643
endpoint. For `ESP32-DevKitC`, `ESP32-WROVER-KIT_V4.1` and `ESP32C3-DevKitM`, a

‎examples/bridge-app/esp32/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# CHIP ESP32 Bridge App Example
22

3-
Refer to
4-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
5-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
3+
Please
4+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
5+
and refer
6+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
67
guides to get started.
78

89
---

‎examples/light-switch-app/esp32/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
This example demonstrates the Matter Light-switch application on ESP platforms.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
7-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
7+
and refer
8+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
89
guides to get started.
910

1011
---

‎examples/lighting-app/esp32/README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22

33
This example demonstrates the Matter Lighting application on ESP platforms.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
7-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
7+
and refer
8+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
89
guides to get started.
910

1011
---
1112

1213
- [Cluster Control](#cluster-control)
13-
- [Steps to Try Lighting app OTA Requestor](#steps-to-try-lighting-app-ota-requestor)
14-
- Please check [Matter OTA guide](../../../docs/guides/esp32/ota.md) for
15-
trying out OTA
14+
- [Matter OTA guide](../../../docs/guides/esp32/ota.md)
1615

1716
---
1817

‎examples/lock-app/esp32/README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,17 @@
22

33
This example demonstrates the mapping of OnOff cluster to lock/unlock logic.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
7-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
7+
and refer
8+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
89
guides to get started.
910

1011
---
1112

1213
- [Cluster control](#cluster-control)
1314
- [Example Demo](#example-demo)
14-
- Please refer
15-
[RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
16-
for using RPC and device tracing
15+
- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
1716

1817
---
1918

‎examples/ota-provider-app/esp32/README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
A prototype application that demonstrates OTA provider capabilities.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) guide
7-
to get started.
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
87

98
---
109

11-
- [Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
10+
- [Building and Commissioning](#building-and-commissioning)
1211
- [Access control list requirements](#access-control-list-requirements)
1312
- [Set delayed action time (Optional)](#set-delayed-action-time-optional)
1413

1514
---
1615

17-
### Build, Flash, Monitor, and Commissioning
16+
### Building and Commissioning
1817

1918
Generate the OTA image as described
2019
[here](../../../docs/guides/esp32/ota.md#generate-chip-ota-image)

‎examples/ota-requestor-app/esp32/README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
A prototype application that demonstrates OTA Requestor capabilities.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
7-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
7+
and refer
8+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
89
guides to get started.
910

1011
---
@@ -13,9 +14,7 @@ guides to get started.
1314
- [Query for an OTA Image](#query-for-an-ota-image)
1415
- [ESP32 OTA Requestor with Linux OTA Provider](#esp32-ota-requestor-with-linux-ota-provider)
1516
- [Generate OTA image](#generate-ota-image)
16-
- Please refer
17-
[RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
18-
for using RPC and device tracing
17+
- [RPC console and Device Tracing](../../../docs/guides/esp32/rpc_console.md)
1918

2019
---
2120

‎examples/persistent-storage/esp32/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
An example testing and demonstrating the key value storage API.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
7-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
7+
and refer
8+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
89
guides to get started.
910

1011
---

‎examples/pigweed-app/esp32/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# CHIP ESP32 Pigweed Example Application
22

3-
Refer to
4-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
5-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
3+
Please
4+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
5+
and refer
6+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
67
guides to get started.
78

89
---

‎examples/temperature-measurement-app/esp32/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
This example is meant to represent a minimal-sized application.
44

5-
Refer to
6-
[setup ESP-IDF and CHIP Environment](#setup-esp-idf-and-chip-environment) and
7-
[Build, Flash, Monitor, and Commissioning](#build-flash-monitor-and-commissioning)
5+
Please
6+
[setup ESP-IDF and CHIP Environment](../../../docs/guides/esp32/setup_idf_chip.md)
7+
and refer
8+
[building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md)
89
guides to get started.
910

1011
---

0 commit comments

Comments
 (0)