Skip to content

Commit b79c6c6

Browse files
authored
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
1 parent 728d138 commit b79c6c6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+366
-397
lines changed

docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# New Clusters & Device Types
1+
# Implementing New Clusters & Device Types
22

33
The goal of new cluster and device type development is to
44

docs/cluster_and_device_type_dev/how_to_add_new_dts_and_clusters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to Add New Device Types & Clusters
1+
# Adding new clusters and device types to the codegen
22

33
This document outlines the process needed to add a new Matter device type and
44
related clusters. Obviously, the steps below assume that the related Matter

docs/cluster_and_device_type_dev/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ types in the SDK.
1313
```
1414

1515
- [Cluster and device type development](./cluster_and_device_type_dev.md)
16-
- [How To Add New Device Types & Clusters](how_to_add_new_dts_and_clusters.md)
16+
- [How To Add New Device Types & Clusters](./how_to_add_new_dts_and_clusters.md)
1717
- [Cluster Server design](./unit_testing_clusters.md)

docs/examples/air_purifier.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Air Purifier
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
air-purifier-app/**/README
8+
```

docs/examples/air_quality.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Air Quality
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
air-quality-sensor-app/**/README
8+
```

docs/examples/all_clusters.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## All clusters
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
all-clusters-app/**/README
8+
```

docs/examples/all_clusters_minimal.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## All clusters minimal
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
all-clusters-minimal-app/**/README
8+
```

docs/examples/bridge.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Bridge
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
bridge-app/**/README
8+
```

docs/examples/chef.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## CHEF
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
chef/README*
8+
chef/**/README
9+
```

docs/examples/chip_tool.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## CHIP Tool example
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
chip-tool/README
8+
```

docs/examples/contact_sensor.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Contact Sensor
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
contact-sensor-app/**/README
8+
```

docs/examples/darwin.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## CHIP Tool Darwin
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
darwin-framework-tool/README
8+
```

docs/examples/dishwasher.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Dishwasher
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
dishwasher-app/**/README
8+
```

docs/examples/energy_management.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Energy Management
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
energy-management-app/**/README
8+
```

docs/examples/fabric_admin.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Fabric Admin
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
fabric-admin/README
8+
```

docs/examples/fabric_bridge.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Fabric Bridge
2+
3+
```{toctree}
4+
:glob:
5+
:maxdepth: 1
6+
7+
fabric-bridge-app/**/README
8+
```

0 commit comments

Comments
 (0)