Documentation: more reorganization (project-chip#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
rquidute · Oct 18, 2024 · b79c6c6 · b79c6c6
1 parent 728d138
commit b79c6c6
Show file tree

Hide file tree

Showing 50 changed files with 366 additions and 397 deletions.
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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,8 @@
+## Bridge
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+bridge-app/**/README
+```
diff --git a/docs/examples/chef.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,8 @@
+## Fabric Bridge
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+fabric-bridge-app/**/README
+```