From b79c6c6ff1ee6221570890c81593d3407cb96019 Mon Sep 17 00:00:00 2001 From: C Freeman Date: Fri, 18 Oct 2024 14:22:48 -0400 Subject: [PATCH] Documentation: more reorganization (#36100) * Documentation: Fix NXP index * Documentation: Fix up getting started ordering, names * Documentation: Fix up new cluster section names * Documentation: fix examples - group into sub-tables - un-smurf-name --- .../cluster_and_device_type_dev.md | 2 +- .../how_to_add_new_dts_and_clusters.md | 2 +- docs/cluster_and_device_type_dev/index.md | 2 +- docs/examples/air_purifier.md | 8 + docs/examples/air_quality.md | 8 + docs/examples/all_clusters.md | 8 + docs/examples/all_clusters_minimal.md | 8 + docs/examples/bridge.md | 8 + docs/examples/chef.md | 9 + docs/examples/chip_tool.md | 8 + docs/examples/contact_sensor.md | 8 + docs/examples/darwin.md | 8 + docs/examples/dishwasher.md | 8 + docs/examples/energy_management.md | 8 + docs/examples/fabric_admin.md | 8 + docs/examples/fabric_bridge.md | 8 + docs/examples/index.md | 387 +----------------- docs/examples/java_matter_controller.md | 8 + docs/examples/kotlin_matter_controller.md | 8 + docs/examples/laundry_washer.md | 8 + docs/examples/light_switch.md | 9 + docs/examples/lighting.md | 9 + docs/examples/lighting_no_unique_id.md | 8 + docs/examples/lit_icd.md | 8 + docs/examples/lock.md | 9 + docs/examples/log_source.md | 8 + docs/examples/microwave.md | 8 + docs/examples/minimal_mdns.md | 8 + .../network_infrastructure_manager.md | 8 + docs/examples/ota_provider.md | 8 + docs/examples/ota_requestor.md | 8 + docs/examples/persistent_storage.md | 9 + docs/examples/pigweed.md | 8 + docs/examples/pump.md | 8 + docs/examples/pump_controler.md | 8 + docs/examples/refrigerator.md | 8 + docs/examples/rvc.md | 8 + docs/examples/shell.md | 9 + docs/examples/smoke_co.md | 8 + docs/examples/tbr.md | 8 + docs/examples/temperature_measurement.md | 8 + docs/examples/thermostat.md | 9 + docs/examples/tv.md | 8 + docs/examples/tv_casting.md | 9 + docs/examples/virtual_device.md | 8 + docs/examples/window.md | 8 + docs/getting_started/SDKBasics.md | 2 +- docs/getting_started/first_example.md | 2 +- docs/getting_started/index.md | 7 +- docs/platforms/nxp/index.md | 15 +- 50 files changed, 366 insertions(+), 397 deletions(-) create mode 100644 docs/examples/air_purifier.md create mode 100644 docs/examples/air_quality.md create mode 100644 docs/examples/all_clusters.md create mode 100644 docs/examples/all_clusters_minimal.md create mode 100644 docs/examples/bridge.md create mode 100644 docs/examples/chef.md create mode 100644 docs/examples/chip_tool.md create mode 100644 docs/examples/contact_sensor.md create mode 100644 docs/examples/darwin.md create mode 100644 docs/examples/dishwasher.md create mode 100644 docs/examples/energy_management.md create mode 100644 docs/examples/fabric_admin.md create mode 100644 docs/examples/fabric_bridge.md create mode 100644 docs/examples/java_matter_controller.md create mode 100644 docs/examples/kotlin_matter_controller.md create mode 100644 docs/examples/laundry_washer.md create mode 100644 docs/examples/light_switch.md create mode 100644 docs/examples/lighting.md create mode 100644 docs/examples/lighting_no_unique_id.md create mode 100644 docs/examples/lit_icd.md create mode 100644 docs/examples/lock.md create mode 100644 docs/examples/log_source.md create mode 100644 docs/examples/microwave.md create mode 100644 docs/examples/minimal_mdns.md create mode 100644 docs/examples/network_infrastructure_manager.md create mode 100644 docs/examples/ota_provider.md create mode 100644 docs/examples/ota_requestor.md create mode 100644 docs/examples/persistent_storage.md create mode 100644 docs/examples/pigweed.md create mode 100644 docs/examples/pump.md create mode 100644 docs/examples/pump_controler.md create mode 100644 docs/examples/refrigerator.md create mode 100644 docs/examples/rvc.md create mode 100644 docs/examples/shell.md create mode 100644 docs/examples/smoke_co.md create mode 100644 docs/examples/tbr.md create mode 100644 docs/examples/temperature_measurement.md create mode 100644 docs/examples/thermostat.md create mode 100644 docs/examples/tv.md create mode 100644 docs/examples/tv_casting.md create mode 100644 docs/examples/virtual_device.md create mode 100644 docs/examples/window.md diff --git a/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md b/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md index e2460ff5a0a2b2..a19336a5939b73 100644 --- a/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md +++ b/docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md @@ -1,4 +1,4 @@ -# New Clusters & Device Types +# Implementing New Clusters & Device Types The goal of new cluster and device type development is to diff --git a/docs/cluster_and_device_type_dev/how_to_add_new_dts_and_clusters.md b/docs/cluster_and_device_type_dev/how_to_add_new_dts_and_clusters.md index 90d82c60310a90..3e3704699d10f5 100644 --- a/docs/cluster_and_device_type_dev/how_to_add_new_dts_and_clusters.md +++ b/docs/cluster_and_device_type_dev/how_to_add_new_dts_and_clusters.md @@ -1,4 +1,4 @@ -# How to Add New Device Types & Clusters +# Adding new clusters and device types to the codegen This document outlines the process needed to add a new Matter device type and related clusters. Obviously, the steps below assume that the related Matter diff --git a/docs/cluster_and_device_type_dev/index.md b/docs/cluster_and_device_type_dev/index.md index cf43d02651378c..0ec65df347f9cd 100644 --- a/docs/cluster_and_device_type_dev/index.md +++ b/docs/cluster_and_device_type_dev/index.md @@ -13,5 +13,5 @@ types in the SDK. ``` - [Cluster and device type development](./cluster_and_device_type_dev.md) -- [How To Add New Device Types & Clusters](how_to_add_new_dts_and_clusters.md) +- [How To Add New Device Types & Clusters](./how_to_add_new_dts_and_clusters.md) - [Cluster Server design](./unit_testing_clusters.md) diff --git a/docs/examples/air_purifier.md b/docs/examples/air_purifier.md new file mode 100644 index 00000000000000..fbac74357fadd2 --- /dev/null +++ b/docs/examples/air_purifier.md @@ -0,0 +1,8 @@ +## Air Purifier + +```{toctree} +:glob: +:maxdepth: 1 + +air-purifier-app/**/README +``` diff --git a/docs/examples/air_quality.md b/docs/examples/air_quality.md new file mode 100644 index 00000000000000..2f6e43a7783709 --- /dev/null +++ b/docs/examples/air_quality.md @@ -0,0 +1,8 @@ +## Air Quality + +```{toctree} +:glob: +:maxdepth: 1 + +air-quality-sensor-app/**/README +``` diff --git a/docs/examples/all_clusters.md b/docs/examples/all_clusters.md new file mode 100644 index 00000000000000..f16a2723e88c05 --- /dev/null +++ b/docs/examples/all_clusters.md @@ -0,0 +1,8 @@ +## All clusters + +```{toctree} +:glob: +:maxdepth: 1 + +all-clusters-app/**/README +``` diff --git a/docs/examples/all_clusters_minimal.md b/docs/examples/all_clusters_minimal.md new file mode 100644 index 00000000000000..0000772c763dd5 --- /dev/null +++ b/docs/examples/all_clusters_minimal.md @@ -0,0 +1,8 @@ +## All clusters minimal + +```{toctree} +:glob: +:maxdepth: 1 + +all-clusters-minimal-app/**/README +``` diff --git a/docs/examples/bridge.md b/docs/examples/bridge.md new file mode 100644 index 00000000000000..fe4655da580ed0 --- /dev/null +++ b/docs/examples/bridge.md @@ -0,0 +1,8 @@ +## Bridge + +```{toctree} +:glob: +:maxdepth: 1 + +bridge-app/**/README +``` diff --git a/docs/examples/chef.md b/docs/examples/chef.md new file mode 100644 index 00000000000000..e17ea88b64d51e --- /dev/null +++ b/docs/examples/chef.md @@ -0,0 +1,9 @@ +## CHEF + +```{toctree} +:glob: +:maxdepth: 1 + +chef/README* +chef/**/README +``` diff --git a/docs/examples/chip_tool.md b/docs/examples/chip_tool.md new file mode 100644 index 00000000000000..8c9b74deabbdff --- /dev/null +++ b/docs/examples/chip_tool.md @@ -0,0 +1,8 @@ +## CHIP Tool example + +```{toctree} +:glob: +:maxdepth: 1 + +chip-tool/README +``` diff --git a/docs/examples/contact_sensor.md b/docs/examples/contact_sensor.md new file mode 100644 index 00000000000000..1daca03f007083 --- /dev/null +++ b/docs/examples/contact_sensor.md @@ -0,0 +1,8 @@ +## Contact Sensor + +```{toctree} +:glob: +:maxdepth: 1 + +contact-sensor-app/**/README +``` diff --git a/docs/examples/darwin.md b/docs/examples/darwin.md new file mode 100644 index 00000000000000..f16fca866a5376 --- /dev/null +++ b/docs/examples/darwin.md @@ -0,0 +1,8 @@ +## CHIP Tool Darwin + +```{toctree} +:glob: +:maxdepth: 1 + +darwin-framework-tool/README +``` diff --git a/docs/examples/dishwasher.md b/docs/examples/dishwasher.md new file mode 100644 index 00000000000000..7ceaa98791cff3 --- /dev/null +++ b/docs/examples/dishwasher.md @@ -0,0 +1,8 @@ +## Dishwasher + +```{toctree} +:glob: +:maxdepth: 1 + +dishwasher-app/**/README +``` diff --git a/docs/examples/energy_management.md b/docs/examples/energy_management.md new file mode 100644 index 00000000000000..dfec14dd68c651 --- /dev/null +++ b/docs/examples/energy_management.md @@ -0,0 +1,8 @@ +## Energy Management + +```{toctree} +:glob: +:maxdepth: 1 + +energy-management-app/**/README +``` diff --git a/docs/examples/fabric_admin.md b/docs/examples/fabric_admin.md new file mode 100644 index 00000000000000..fa47159c50a091 --- /dev/null +++ b/docs/examples/fabric_admin.md @@ -0,0 +1,8 @@ +## Fabric Admin + +```{toctree} +:glob: +:maxdepth: 1 + +fabric-admin/README +``` diff --git a/docs/examples/fabric_bridge.md b/docs/examples/fabric_bridge.md new file mode 100644 index 00000000000000..de08b59318662b --- /dev/null +++ b/docs/examples/fabric_bridge.md @@ -0,0 +1,8 @@ +## Fabric Bridge + +```{toctree} +:glob: +:maxdepth: 1 + +fabric-bridge-app/**/README +``` diff --git a/docs/examples/index.md b/docs/examples/index.md index 67dcfcf36b0e55..75118fa9335aad 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,390 +1,11 @@ # Examples -The Matter SDK provides examples of Matter devices for different development -platforms. - -## Air Quality Sensor example - -```{toctree} -:glob: -:maxdepth: 1 - -air-quality-sensor-app/**/README -``` - -## All clusters example - -```{toctree} -:glob: -:maxdepth: 1 - -all-clusters-app/**/README -``` - -## All clusters minimal example - -```{toctree} -:glob: -:maxdepth: 1 - -all-clusters-minimal-app/**/README -``` - -## Bridge example - -```{toctree} -:glob: -:maxdepth: 1 - -bridge-app/**/README -``` - -## Contact Sensor Example - -```{toctree} -:glob: -:maxdepth: 1 - -contact-sensor-app/**/README -``` - -## CHEF example - -```{toctree} -:glob: -:maxdepth: 1 - -chef/README* -chef/**/README -``` - -## CHIP Tool example - -```{toctree} -:glob: -:maxdepth: 1 - -chip-tool/README -``` - -## CHIP Tool Darwin example - -```{toctree} -:glob: -:maxdepth: 1 - -darwin-framework-tool/README -``` - -## Energy Management example - -```{toctree} -:glob: -:maxdepth: 1 - -energy-management-app/**/README -``` - -## Fabric Admin example - -```{toctree} -:glob: -:maxdepth: 1 - -fabric-admin/README -``` - -## Fabric Bridge example - -```{toctree} -:glob: -:maxdepth: 1 - -fabric-bridge-app/**/README -``` - -## Java matter controller example - -```{toctree} -:glob: -:maxdepth: 1 - -java-matter-controller/README -``` - -## Kotlin matter controller example - -```{toctree} -:glob: -:maxdepth: 1 - -kotlin-matter-controller/README -``` - -## Virtual Device App example - -```{toctree} -:glob: -:maxdepth: 1 - -virtual-device-app/**/README -``` - -## Laundry washer example - -```{toctree} -:glob: -:maxdepth: 1 - -laundry-washer-app/**/README -``` - -## Lighting example - ```{toctree} :glob: -:maxdepth: 1 +:maxdepth: 2 -lighting-app/**/README -lighting-app/qpg/APPLICATION +* ``` -## Lighting example without unique id - -```{toctree} -:glob: -:maxdepth: 1 - -lighting-app-data-mode-no-unique-id/**/README -``` - -## Light switch example - -```{toctree} -:glob: -:maxdepth: 1 - -light-switch-app/**/README -light-switch-app/qpg/APPLICATION -``` - -## Lock example - -```{toctree} -:glob: -:maxdepth: 1 - -lock-app/**/README -lock-app/qpg/APPLICATION -``` - -## Log source example - -```{toctree} -:glob: -:maxdepth: 1 - -log-source-app/**/README -``` - -## Minimal MDNS example - -```{toctree} -:glob: -:maxdepth: 1 - -minimal-mdns/README -``` - -## OTA Provider example - -```{toctree} -:glob: -:maxdepth: 1 - -ota-provider-app/**/README -``` - -## OTA Requestor example - -```{toctree} -:glob: -:maxdepth: 1 - -ota-requestor-app/**/README -``` - -## Persistent storage example - -```{toctree} -:glob: -:maxdepth: 1 - -persistent-storage/**/README -persistent-storage/**/APPLICATION -``` - -## Pigweed example - -```{toctree} -:glob: -:maxdepth: 1 - -pigweed-app/**/README -``` - -## Pump example - -```{toctree} -:glob: -:maxdepth: 1 - -pump-app/**/README -``` - -## Pump controller example - -```{toctree} -:glob: -:maxdepth: 1 - -pump-controller-app/**/README -``` - -## Refrigerator example - -```{toctree} -:glob: -:maxdepth: 1 - -refrigerator-app/**/README -``` - -## Shell example - -```{toctree} -:glob: -:maxdepth: 1 - -shell/README* -shell/**/README -``` - -## Smoke CO Alarm example - -```{toctree} -:glob: -:maxdepth: 1 - -smoke-co-alarm-app/**/README -``` - -## Dishwasher example - -```{toctree} -:glob: -:maxdepth: 1 - -dishwasher-app/**/README -``` - -## Microwave oven example - -```{toctree} -:glob: -:maxdepth: 1 - -microwave-oven-app/**/README -``` - -## Temperature measurement example - -```{toctree} -:glob: -:maxdepth: 1 - -temperature-measurement-app/**/README -``` - -## Thermostat example - -```{toctree} -:glob: -:maxdepth: 1 - -thermostat/**/README -thermostat/qpg/APPLICATION -``` - -## TV example - -```{toctree} -:glob: -:maxdepth: 1 - -tv-app/**/README -``` - -## TV casting example - -```{toctree} -:glob: -:maxdepth: 1 - -tv-casting-app/**/README -tv-casting-app/APIs.md -``` - -## Window example - -```{toctree} -:glob: -:maxdepth: 1 - -window-app/**/README -``` - -## RVC example - -```{toctree} -:glob: -:maxdepth: 1 - -rvc-app/README -``` - -## Air Purifier Example - -```{toctree} -:glob: -:maxdepth: 1 - -air-purifier-app/**/README -``` - -## Network Infrastructure Manager example - -```{toctree} -:glob: -:maxdepth: 1 - -network-manager-app/README -``` - -## Lit ICD example - -```{toctree} -:glob: -:maxdepth: 1 - -lit-icd-app/**/README -``` - -## Thread Border Router example - -```{toctree} -:glob: -:maxdepth: 1 - -thread-br-app/**/README -``` +The Matter SDK provides examples of Matter devices for different development +platforms. diff --git a/docs/examples/java_matter_controller.md b/docs/examples/java_matter_controller.md new file mode 100644 index 00000000000000..58af7cbf26729d --- /dev/null +++ b/docs/examples/java_matter_controller.md @@ -0,0 +1,8 @@ +## Java matter controller + +```{toctree} +:glob: +:maxdepth: 1 + +java-matter-controller/README +``` diff --git a/docs/examples/kotlin_matter_controller.md b/docs/examples/kotlin_matter_controller.md new file mode 100644 index 00000000000000..9241a1ef182131 --- /dev/null +++ b/docs/examples/kotlin_matter_controller.md @@ -0,0 +1,8 @@ +## Kotlin matter controller + +```{toctree} +:glob: +:maxdepth: 1 + +kotlin-matter-controller/README +``` diff --git a/docs/examples/laundry_washer.md b/docs/examples/laundry_washer.md new file mode 100644 index 00000000000000..3a522c8f821819 --- /dev/null +++ b/docs/examples/laundry_washer.md @@ -0,0 +1,8 @@ +## Laundry washer + +```{toctree} +:glob: +:maxdepth: 1 + +laundry-washer-app/**/README +``` diff --git a/docs/examples/light_switch.md b/docs/examples/light_switch.md new file mode 100644 index 00000000000000..1a887fc6b4ef6a --- /dev/null +++ b/docs/examples/light_switch.md @@ -0,0 +1,9 @@ +## Light switch + +```{toctree} +:glob: +:maxdepth: 1 + +light-switch-app/**/README +light-switch-app/qpg/APPLICATION +``` diff --git a/docs/examples/lighting.md b/docs/examples/lighting.md new file mode 100644 index 00000000000000..8870e50372c742 --- /dev/null +++ b/docs/examples/lighting.md @@ -0,0 +1,9 @@ +## Lighting + +```{toctree} +:glob: +:maxdepth: 1 + +lighting-app/**/README +lighting-app/qpg/APPLICATION +``` diff --git a/docs/examples/lighting_no_unique_id.md b/docs/examples/lighting_no_unique_id.md new file mode 100644 index 00000000000000..a71f9df5225b07 --- /dev/null +++ b/docs/examples/lighting_no_unique_id.md @@ -0,0 +1,8 @@ +## Lighting without unique id + +```{toctree} +:glob: +:maxdepth: 1 + +lighting-app-data-mode-no-unique-id/**/README +``` diff --git a/docs/examples/lit_icd.md b/docs/examples/lit_icd.md new file mode 100644 index 00000000000000..8678c44fcd743f --- /dev/null +++ b/docs/examples/lit_icd.md @@ -0,0 +1,8 @@ +## Lit ICD + +```{toctree} +:glob: +:maxdepth: 1 + +lit-icd-app/**/README +``` diff --git a/docs/examples/lock.md b/docs/examples/lock.md new file mode 100644 index 00000000000000..16ab19dc64b3d7 --- /dev/null +++ b/docs/examples/lock.md @@ -0,0 +1,9 @@ +## Lock + +```{toctree} +:glob: +:maxdepth: 1 + +lock-app/**/README +lock-app/qpg/APPLICATION +``` diff --git a/docs/examples/log_source.md b/docs/examples/log_source.md new file mode 100644 index 00000000000000..caec22654d0d60 --- /dev/null +++ b/docs/examples/log_source.md @@ -0,0 +1,8 @@ +## Log source + +```{toctree} +:glob: +:maxdepth: 1 + +log-source-app/**/README +``` diff --git a/docs/examples/microwave.md b/docs/examples/microwave.md new file mode 100644 index 00000000000000..c5f659f8733b79 --- /dev/null +++ b/docs/examples/microwave.md @@ -0,0 +1,8 @@ +## Microwave ovens + +```{toctree} +:glob: +:maxdepth: 1 + +microwave-oven-app/**/README +``` diff --git a/docs/examples/minimal_mdns.md b/docs/examples/minimal_mdns.md new file mode 100644 index 00000000000000..9d65b4dab23440 --- /dev/null +++ b/docs/examples/minimal_mdns.md @@ -0,0 +1,8 @@ +## Minimal MDNS + +```{toctree} +:glob: +:maxdepth: 1 + +minimal-mdns/README +``` diff --git a/docs/examples/network_infrastructure_manager.md b/docs/examples/network_infrastructure_manager.md new file mode 100644 index 00000000000000..bcc0591037e87f --- /dev/null +++ b/docs/examples/network_infrastructure_manager.md @@ -0,0 +1,8 @@ +## Network Infrastructure Manager + +```{toctree} +:glob: +:maxdepth: 1 + +network-manager-app/README +``` diff --git a/docs/examples/ota_provider.md b/docs/examples/ota_provider.md new file mode 100644 index 00000000000000..3470d9fe078bf8 --- /dev/null +++ b/docs/examples/ota_provider.md @@ -0,0 +1,8 @@ +## OTA Provider + +```{toctree} +:glob: +:maxdepth: 1 + +ota-provider-app/**/README +``` diff --git a/docs/examples/ota_requestor.md b/docs/examples/ota_requestor.md new file mode 100644 index 00000000000000..9cf5a75feafa4d --- /dev/null +++ b/docs/examples/ota_requestor.md @@ -0,0 +1,8 @@ +## OTA Requestor + +```{toctree} +:glob: +:maxdepth: 1 + +ota-requestor-app/**/README +``` diff --git a/docs/examples/persistent_storage.md b/docs/examples/persistent_storage.md new file mode 100644 index 00000000000000..5f5f5d17581282 --- /dev/null +++ b/docs/examples/persistent_storage.md @@ -0,0 +1,9 @@ +## Persistent storage + +```{toctree} +:glob: +:maxdepth: 1 + +persistent-storage/**/README +persistent-storage/**/APPLICATION +``` diff --git a/docs/examples/pigweed.md b/docs/examples/pigweed.md new file mode 100644 index 00000000000000..bf670bebd0cfa1 --- /dev/null +++ b/docs/examples/pigweed.md @@ -0,0 +1,8 @@ +## Pigweed + +```{toctree} +:glob: +:maxdepth: 1 + +pigweed-app/**/README +``` diff --git a/docs/examples/pump.md b/docs/examples/pump.md new file mode 100644 index 00000000000000..001a7df3fcf287 --- /dev/null +++ b/docs/examples/pump.md @@ -0,0 +1,8 @@ +## Pump + +```{toctree} +:glob: +:maxdepth: 1 + +pump-app/**/README +``` diff --git a/docs/examples/pump_controler.md b/docs/examples/pump_controler.md new file mode 100644 index 00000000000000..ff7f51f5ecb4ec --- /dev/null +++ b/docs/examples/pump_controler.md @@ -0,0 +1,8 @@ +## Pump controller + +```{toctree} +:glob: +:maxdepth: 1 + +pump-controller-app/**/README +``` diff --git a/docs/examples/refrigerator.md b/docs/examples/refrigerator.md new file mode 100644 index 00000000000000..455e8fe703b7cd --- /dev/null +++ b/docs/examples/refrigerator.md @@ -0,0 +1,8 @@ +## Refrigerator + +```{toctree} +:glob: +:maxdepth: 1 + +refrigerator-app/**/README +``` diff --git a/docs/examples/rvc.md b/docs/examples/rvc.md new file mode 100644 index 00000000000000..e0d033c4474eab --- /dev/null +++ b/docs/examples/rvc.md @@ -0,0 +1,8 @@ +## RVC + +```{toctree} +:glob: +:maxdepth: 1 + +rvc-app/README +``` diff --git a/docs/examples/shell.md b/docs/examples/shell.md new file mode 100644 index 00000000000000..3a0536a3dc8dfa --- /dev/null +++ b/docs/examples/shell.md @@ -0,0 +1,9 @@ +## Shell + +```{toctree} +:glob: +:maxdepth: 1 + +shell/README* +shell/**/README +``` diff --git a/docs/examples/smoke_co.md b/docs/examples/smoke_co.md new file mode 100644 index 00000000000000..9144276c7ac7e1 --- /dev/null +++ b/docs/examples/smoke_co.md @@ -0,0 +1,8 @@ +## Smoke CO Alarm example + +```{toctree} +:glob: +:maxdepth: 1 + +smoke-co-alarm-app/**/README +``` diff --git a/docs/examples/tbr.md b/docs/examples/tbr.md new file mode 100644 index 00000000000000..512a1132228b1d --- /dev/null +++ b/docs/examples/tbr.md @@ -0,0 +1,8 @@ +## Thread Border Router + +```{toctree} +:glob: +:maxdepth: 1 + +thread-br-app/**/README +``` diff --git a/docs/examples/temperature_measurement.md b/docs/examples/temperature_measurement.md new file mode 100644 index 00000000000000..cf8235b1d49611 --- /dev/null +++ b/docs/examples/temperature_measurement.md @@ -0,0 +1,8 @@ +## Temperature measurement + +```{toctree} +:glob: +:maxdepth: 1 + +temperature-measurement-app/**/README +``` diff --git a/docs/examples/thermostat.md b/docs/examples/thermostat.md new file mode 100644 index 00000000000000..8eb87892be665d --- /dev/null +++ b/docs/examples/thermostat.md @@ -0,0 +1,9 @@ +## Thermostat + +```{toctree} +:glob: +:maxdepth: 1 + +thermostat/**/README +thermostat/qpg/APPLICATION +``` diff --git a/docs/examples/tv.md b/docs/examples/tv.md new file mode 100644 index 00000000000000..ee97387402eadb --- /dev/null +++ b/docs/examples/tv.md @@ -0,0 +1,8 @@ +## TV + +```{toctree} +:glob: +:maxdepth: 1 + +tv-app/**/README +``` diff --git a/docs/examples/tv_casting.md b/docs/examples/tv_casting.md new file mode 100644 index 00000000000000..caeedf9e6dcaca --- /dev/null +++ b/docs/examples/tv_casting.md @@ -0,0 +1,9 @@ +## TV casting + +```{toctree} +:glob: +:maxdepth: 1 + +tv-casting-app/**/README +tv-casting-app/APIs.md +``` diff --git a/docs/examples/virtual_device.md b/docs/examples/virtual_device.md new file mode 100644 index 00000000000000..0b50f145033da1 --- /dev/null +++ b/docs/examples/virtual_device.md @@ -0,0 +1,8 @@ +## Virtual Device App + +```{toctree} +:glob: +:maxdepth: 1 + +virtual-device-app/**/README +``` diff --git a/docs/examples/window.md b/docs/examples/window.md new file mode 100644 index 00000000000000..2b4993641c9dbd --- /dev/null +++ b/docs/examples/window.md @@ -0,0 +1,8 @@ +## Window + +```{toctree} +:glob: +:maxdepth: 1 + +window-app/**/README +``` diff --git a/docs/getting_started/SDKBasics.md b/docs/getting_started/SDKBasics.md index 7f2c81f285fceb..eaad3baac81e8f 100644 --- a/docs/getting_started/SDKBasics.md +++ b/docs/getting_started/SDKBasics.md @@ -1,4 +1,4 @@ -# SDK Basics +# SDK Architecture Overview ## Getting Started diff --git a/docs/getting_started/first_example.md b/docs/getting_started/first_example.md index 14fe239749ab17..d75d9e7b1a4fee 100644 --- a/docs/getting_started/first_example.md +++ b/docs/getting_started/first_example.md @@ -1,4 +1,4 @@ -# An SDK example +# Compiling, Running, and Controlling Matter examples The SDK provides a number of example devices and controllers that can be used to familiarize yourself with the SDK and the Matter ecosystem. diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index 098f047ed75393..1bfbe3f57cc333 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -7,11 +7,14 @@ The following docs are a brief introduction to SDK development. :maxdepth: 1 :hidden: -* +first_example +changing_examples +SDKBasics +zap ``` - [Running your first example](./first_example.md) - [Changing examples](./changing_examples.md) -- [SDK Architecture Introduction](./SDKBasics.md) +- [SDK Architecture Overview](./SDKBasics.md) - [ZAP Introduction](./zap.md) diff --git a/docs/platforms/nxp/index.md b/docs/platforms/nxp/index.md index fc11ed78b2baff..844dc40194cebb 100644 --- a/docs/platforms/nxp/index.md +++ b/docs/platforms/nxp/index.md @@ -1,14 +1,15 @@ +# NXP + ```{toctree} :glob: :maxdepth: 1 +:hidden: * ``` -# NXP Getting Started Guide - -- [NXP - Android Commissioning](nxp_k32w_android_commissioning.md) -- [NXP - Linux Examples](nxp_imx8m_linux_examples.md) -- [NXP - Manufacturing Data](nxp_manufacturing_flow.md) -- [NXP - RTs OTA Software Update Guide](nxp_RTs_ota_software_update.md) -- [NXP - Zephyr OTA Software Update Guide](nxp_zephyr_ota_software_update.md) +- [NXP - Android Commissioning](./nxp_k32w_android_commissioning.md) +- [NXP - Linux Examples](./nxp_imx8m_linux_examples.md) +- [NXP - Manufacturing Data](./nxp_manufacturing_flow.md) +- [NXP - RTs OTA Software Update Guide](./nxp_RTs_ota_software_update.md) +- [NXP - Zephyr OTA Software Update Guide](./nxp_zephyr_ota_software_update.md