[nxp fromtree] Docs: Move platform docs into their own directory and …

…separate into subfolders (project-chip#34233) * Move files and add indexes * Fix references for new paths * Fix references * Fix up some new references * move darwin back into guides * remove darwin from platforms * Restyled by prettier-markdown * whoops, didn't save * Restyled by prettier-markdown * fix dishwasher readme * fix boufallolabs readme * fix links --------- Co-authored-by: Restyled.io <[email protected]> (cherry picked from commit 32a375c)
NXP · Nov 20, 2024 · 634c65a · 634c65a
1 parent 79a2e76
commit 634c65a
Show file tree

Hide file tree

Showing 199 changed files with 543 additions and 343 deletions.
diff --git a/docs/guides/repl/Matter_Access_Control.ipynb → ...ers/chip-repl/Matter_Access_Control.ipynb b/docs/guides/repl/Matter_Access_Control.ipynb → ...ers/chip-repl/Matter_Access_Control.ipynb
diff --git a/...ides/repl/Matter_Basic_Interactions.ipynb → ...chip-repl/Matter_Basic_Interactions.ipynb b/...ides/repl/Matter_Basic_Interactions.ipynb → ...chip-repl/Matter_Basic_Interactions.ipynb
diff --git a/...l/Matter_Multi_Fabric_Commissioning.ipynb → ...l/Matter_Multi_Fabric_Commissioning.ipynb b/...l/Matter_Multi_Fabric_Commissioning.ipynb → ...l/Matter_Multi_Fabric_Commissioning.ipynb
diff --git a/docs/guides/repl/Matter_REPL_Intro.ipynb → ...rollers/chip-repl/Matter_REPL_Intro.ipynb b/docs/guides/repl/Matter_REPL_Intro.ipynb → ...rollers/chip-repl/Matter_REPL_Intro.ipynb
diff --git a/docs/development_controllers/chip-repl/index.md b/docs/development_controllers/chip-repl/index.md
@@ -0,0 +1,15 @@
+# chip-repl
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+-   [Matter REPL](./matter-repl.md)
+-   [Intro](./Matter_REPL_Intro.ipynb)
+-   [Access Control](./Matter_Access_Control.ipynb)
+-   [Basic interactions](./Matter_Basic_Interactions.ipynb)
+-   [Fabric Commissioning](./Matter_Multi_Fabric_Commissioning.ipynb)
diff --git a/docs/guides/matter-repl.md → ...ment_controllers/chip-repl/matter-repl.md b/docs/guides/matter-repl.md → ...ment_controllers/chip-repl/matter-repl.md
diff --git a/.../python_chip_controller_advanced_usage.md → .../python_chip_controller_advanced_usage.md b/.../python_chip_controller_advanced_usage.md → .../python_chip_controller_advanced_usage.md
diff --git a/...guides/python_chip_controller_building.md → ...p-repl/python_chip_controller_building.md b/...guides/python_chip_controller_building.md → ...p-repl/python_chip_controller_building.md
@@ -39,7 +39,7 @@ Linux (amd64 / aarch64) or macOS.
 To build and run the Python CHIP controller:
 
 1. Install all necessary packages and prepare the build system. For more
-   details, see the [Building Matter](BUILDING.md) documentation:
+   details, see the [Building Matter](../../guides/BUILDING.md) documentation:
 
     ```
     sudo apt-get update
@@ -77,7 +77,8 @@ To build and run the Python CHIP controller:
 5. Build and install the Python CHIP controller:
 
     ```
-    scripts/build_python.sh -m platform -i separate
+    scripts/build_python.sh -m platform -i out/python_env
+    source out/python_env/bin/activate
     ```
 
     > Note: This builds the Python CHIP Controller along with the CHIP REPL as

diff --git a/docs/guides/chip_tool_guide.md → ..._controllers/chip-tool/chip_tool_guide.md b/docs/guides/chip_tool_guide.md → ..._controllers/chip-tool/chip_tool_guide.md
@@ -38,7 +38,8 @@ Before you can use the CHIP Tool, you must compile it from source on Linux
 To build and run the CHIP Tool:
 
 1. Install all required packages for Matter and prepare the source code and the
-   build system. Read the [Building Matter](BUILDING.md) guide for instructions.
+   build system. Read the [Building Matter](../../guides/BUILDING.md) guide for
+   instructions.
 2. Open a command prompt in the `connectedhomeip` directory.
 3. Run the following command:
 

diff --git a/docs/development_controllers/chip-tool/index.md b/docs/development_controllers/chip-tool/index.md
@@ -0,0 +1,11 @@
+# chip-tool
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+-   [chip-tool guide](./chip_tool_guide.md)
diff --git a/docs/development_controllers/index.md b/docs/development_controllers/index.md
@@ -0,0 +1,13 @@
+# Development Controllers
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+chip-repl/index
+chip-tool/index
+```
+
+-   [chip-tool](./chip-tool)
+-   [chip-repl](./chip-repl)
diff --git a/docs/getting_started/first_example.md b/docs/getting_started/first_example.md
@@ -26,7 +26,7 @@ for testing.
 
 [chip-tool](../../examples/chip-tool/) is a C++ command line controller with an
 interactive shell. More information on chip-tool can be found in the
-[chip-tool guide](../guides/chip_tool_guide.md).
+[chip-tool guide](../development_controllers/chip-tool/chip_tool_guide.md).
 
 [chip-repl](../../src/controller/python/chip-repl.py) is a shell for the python
 controller. The chip-repl is part of the python controller framework, often used

diff --git a/docs/guides/darwin.md b/docs/guides/darwin.md
@@ -292,17 +292,17 @@ Example:
 -   [ESP32 Lighting](/examples/lighting-app/esp32/README.md)
 -   [ESP32 Temperature Sensor](/examples/temperature-measurement-app/esp32/README.md)
 -   [mbedOS](/examples/all-clusters-app/mbed/README.md)
--   [nRF Connect All Clusters](./nrfconnect_examples_configuration.md)
+-   [nRF Connect All Clusters](../platforms/nrf/nrfconnect_examples_configuration.md)
 -   [nRF Connect Pump](/examples/pump-app/nrfconnect/README.md)
--   [NXP Examples](./nxp/nxp_imx8m_linux_examples.md)
+-   [NXP Examples](../platforms/nxp/nxp_imx8m_linux_examples.md)
 -   [NXP](/examples/all-clusters-app/nxp/mw320/README.md)
 -   [Infineon CYW30739 Lighting](/examples/lighting-app/infineon/cyw30739/README.md)
 -   [Infineon PSoC6](/examples/all-clusters-app/infineon/psoc6/README.md)
 -   [Qorvo](/examples/lighting-app/qpg/README.md)
--   [Silicon Labs](./silabs_getting_started.md)
+-   [Silicon Labs](../platforms/silabs/silabs_getting_started.md)
 -   [Simulated Linux](./simulated_device_linux.md)
 -   [Telink](/examples/lighting-app/telink/README.md)
--   [TI Platform](./ti/ti_matter_overview.md)
+-   [TI Platform](../platforms/ti/ti_matter_overview.md)
 -   [Tizen](/examples/lighting-app/tizen/README.md)
 
 ## Providing Feedback to Apple

diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -9,56 +9,13 @@ and features.
 :hidden:
 
 *
-bouffalolab/matter_factory_data
-esp32/README
-nxp/README
-ti/ti_matter_overview
 ```
 
 ## Build Guides
 
 -   [Building](./BUILDING.md)
 
-## Platform Guides
-
--   [Android - Building](./android_building.md)
--   [Apple - Testing with iPhone, iPad, macOS, Apple TV, HomePod, Watch, etc](./darwin.md)
--   [ASR - Getting Started Guide](./asr_getting_started_guide.md)
--   [Bouffalo Lab - Matter factory data generation](./bouffalolab/matter_factory_data.md)
--   [Espressif (ESP32) - Getting Started Guide](./esp32/README.md)
--   [Infineon PSoC6 - Software Update](./infineon_psoc6_software_update.md)
--   [Linux - Simulated Devices](./simulated_device_linux.md)
--   [mbedOS - Adding a new target](./mbedos_add_new_target.md)
--   [mbedOS - Commissioning](./mbedos_commissioning.md)
--   [mbedOS - Platform Overview](./mbedos_platform_overview.md)
--   [nRF Connect - Android Commissioning](./nrfconnect_android_commissioning.md)
--   [nRF Connect - CLI Guide](./nrfconnect_examples_cli.md)
--   [nRF Connect - Configuration](./nrfconnect_examples_configuration.md)
--   [nRF Connect - Factory Data Configuration](./nrfconnect_factory_data_configuration.md)
--   [nRF Connect - Platform Overview](./nrfconnect_platform_overview.md)
--   [nRF Connect - Software Update](./nrfconnect_examples_software_update.md)
--   [NXP - Getting Started Guide](./nxp/README.md)
--   [Silicon Labs - Documentation](https://siliconlabs.github.io/matter/latest/index.html)
--   [Silicon Labs - Getting Started](./silabs_getting_started.md)
--   [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
--   [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
--   [TI - Platform Overview](./ti/ti_matter_overview.md)
-
-## Tool Guides
-
--   [CHIP Tool](./chip_tool_guide.md)
--   [Python Matter-Repl](./matter-repl.md)
--   [python-chip-controller - Advanced](./python_chip_controller_advanced_usage.md)
--   [python-chip-controller - Building](./python_chip_controller_building.md)
--   [CHEF test devices](../../examples/chef/README.md)
-    -   [New device type adding](../../examples/chef/NEW_CHEF_DEVICES.md)
-
 ## Development Guides
 
 -   [Access Control](./access-control-guide.md)
 -   [Matter IDL tooling and validation](./matter_idl_tooling.md)
-
-## Setup Guides
-
--   [Open Thread - Hardware suggestions](./openthread_rcp_nrf_dongle.md)
--   [Open Thread - Setting up a Raspberry Pi as a Border Router](./openthread_border_router_pi.md)
diff --git a/docs/index.md b/docs/index.md
@@ -8,9 +8,11 @@
 PROJECT_FLOW
 VSCODE_DEVELOPMENT
 ci-cd/index
+development_controllers/index
 getting_started/index
 cluster_and_device_type_dev/index
 guides/index
+platforms/index
 style/index
 examples/index
 product_considerations/index

diff --git a/docs/guides/android_building.md → docs/platforms/android/android_building.md b/docs/guides/android_building.md → docs/platforms/android/android_building.md
diff --git a/docs/platforms/android/index.md b/docs/platforms/android/index.md
@@ -0,0 +1,11 @@
+# Android
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+[Android - Building](./android_building.md)
diff --git a/docs/guides/asr_getting_started_guide.md → ...latforms/asr/asr_getting_started_guide.md b/docs/guides/asr_getting_started_guide.md → ...latforms/asr/asr_getting_started_guide.md
@@ -33,7 +33,7 @@ to speed up development. You can find them in the samples with `/asr` subfolder.
 
 ## Building the Example Application
 
--   [Setup Matter Environment](./BUILDING.md)
+-   [Setup Matter Environment](../../guides/BUILDING.md)
 
 -   Setup toolchain
     -   for ASR582X and ASR550X
@@ -140,7 +140,7 @@ There are two commissioning modes supported by ASR platform:
    `build_examples.py` script. For example:
    `./scripts/build/build_examples.py --target asr-$ASR_BOARD-lighting-ota build`
 2. For more usage details, please refer to the
-   [OTA example](../../examples/ota-requestor-app/asr/README.md)
+   [OTA example](../../../examples/ota-requestor-app/asr/README.md)
 
 ## Factory
 

diff --git a/docs/platforms/asr/index.md b/docs/platforms/asr/index.md
@@ -0,0 +1,11 @@
+# ASR
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+[ASR - Getting Started Guide](./asr_getting_started_guide.md)
diff --git a/docs/platforms/bouffalolab/index.md b/docs/platforms/bouffalolab/index.md
@@ -0,0 +1,11 @@
+# Bouffalolab
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+[Bouffalo Lab - Matter factory data generation](./matter_factory_data.md)
diff --git a/...guides/bouffalolab/matter_factory_data.md → ...tforms/bouffalolab/matter_factory_data.md b/...guides/bouffalolab/matter_factory_data.md → ...tforms/bouffalolab/matter_factory_data.md
diff --git a/docs/guides/esp32/ble_settings.md → docs/platforms/esp32/ble_settings.md b/docs/guides/esp32/ble_settings.md → docs/platforms/esp32/ble_settings.md
diff --git a/.../guides/esp32/build_app_and_commission.md → ...atforms/esp32/build_app_and_commission.md b/.../guides/esp32/build_app_and_commission.md → ...atforms/esp32/build_app_and_commission.md
@@ -168,7 +168,7 @@ $ out/debug/chip-tool pairing ble-wifi 12345 MY_SSID MY_PASSWORD 20202021 3840
 #### Commissioning the Thread device (ESP32H2)
 
 -   For ESP32-H2, firstly start OpenThread Border Router, you can either use
-    [Raspberry Pi OpenThread Border Router](../openthread_border_router_pi.md)
+    [Raspberry Pi OpenThread Border Router](../openthread/openthread_border_router_pi.md)
     OR
     [ESP32 OpenThread Border Router](../../../examples/thread-br-app/esp32/README.md)
 

diff --git a/docs/guides/esp32/config_options.md → docs/platforms/esp32/config_options.md b/docs/guides/esp32/config_options.md → docs/platforms/esp32/config_options.md
diff --git a/docs/guides/esp32/factory_data.md → docs/platforms/esp32/factory_data.md b/docs/guides/esp32/factory_data.md → docs/platforms/esp32/factory_data.md
diff --git a/docs/guides/esp32/flash_nvs_encryption.md → docs/platforms/esp32/flash_nvs_encryption.md b/docs/guides/esp32/flash_nvs_encryption.md → docs/platforms/esp32/flash_nvs_encryption.md
diff --git a/docs/guides/esp32/README.md → docs/platforms/esp32/index.md b/docs/guides/esp32/README.md → docs/platforms/esp32/index.md
diff --git a/docs/guides/esp32/ota.md → docs/platforms/esp32/ota.md b/docs/guides/esp32/ota.md → docs/platforms/esp32/ota.md
diff --git a/docs/guides/esp32/providers.md → docs/platforms/esp32/providers.md b/docs/guides/esp32/providers.md → docs/platforms/esp32/providers.md
diff --git a/docs/guides/esp32/rpc_console.md → docs/platforms/esp32/rpc_console.md b/docs/guides/esp32/rpc_console.md → docs/platforms/esp32/rpc_console.md
diff --git a/docs/guides/esp32/secure_cert_partition.md → .../platforms/esp32/secure_cert_partition.md b/docs/guides/esp32/secure_cert_partition.md → .../platforms/esp32/secure_cert_partition.md
diff --git a/docs/guides/esp32/setup_idf_chip.md → docs/platforms/esp32/setup_idf_chip.md b/docs/guides/esp32/setup_idf_chip.md → docs/platforms/esp32/setup_idf_chip.md
diff --git a/docs/guides/esp32/vs_code_development.md → docs/platforms/esp32/vs_code_development.md b/docs/guides/esp32/vs_code_development.md → docs/platforms/esp32/vs_code_development.md
diff --git a/docs/platforms/index.md b/docs/platforms/index.md
@@ -0,0 +1,35 @@
+# Platform Guides
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+android/index
+asr/index
+bouffalolab/index
+esp32/index
+infineon/index
+mbedos/index
+nrf/index
+nxp/index
+openiotsdk/index
+openthread/index
+silabs/index
+stm32/index
+ti/index
+```
+
+-   [Android](./android/)
+-   [ASR](./asr/)
+-   [Bouffalo Lab](./bouffalolab)
+-   [ESP32](./esp32/)
+-   [Infineon](./infineon/)
+-   [MbedOS](./mbedos/)
+-   [NRF](./nrf/)
+-   [NXP](./nxp/)
+-   [OpenIoTSDK](./openiotsdk/)
+-   [OpenThread](./openthread/)
+-   [Silabs](./silabs/)
+-   [STM32](./stm32/)
+-   [TI](./ti/)
diff --git a/docs/platforms/infineon/index.md b/docs/platforms/infineon/index.md
@@ -0,0 +1,12 @@
+# Infineon
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+[Provisioning](./infineon_psoc6_software_update.md)
+[Software update](./infineon_psoc6_software_update.md)
diff --git a/.../guides/infineon_psoc6_software_update.md → ...nfineon/infineon_psoc6_software_update.md b/.../guides/infineon_psoc6_software_update.md → ...nfineon/infineon_psoc6_software_update.md
diff --git a/docs/guides/infineon_trustm_provisioning.md → .../infineon/infineon_trustm_provisioning.md b/docs/guides/infineon_trustm_provisioning.md → .../infineon/infineon_trustm_provisioning.md
diff --git a/...ges/matter_mbedos_overview_simplified.png → ...ges/matter_mbedos_overview_simplified.png b/...ges/matter_mbedos_overview_simplified.png → ...ges/matter_mbedos_overview_simplified.png
diff --git a/docs/platforms/mbedos/index.md b/docs/platforms/mbedos/index.md
@@ -0,0 +1,13 @@
+# MbedOS
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+[Add new target](./mbedos_add_new_target.md)
+[Commissioning](./mbedos_commissioning.md)
+[Platform overview](./mbedos_platform_overview.md)
diff --git a/docs/guides/mbedos_add_new_target.md → ...platforms/mbedos/mbedos_add_new_target.md b/docs/guides/mbedos_add_new_target.md → ...platforms/mbedos/mbedos_add_new_target.md
diff --git a/docs/guides/mbedos_commissioning.md → .../platforms/mbedos/mbedos_commissioning.md b/docs/guides/mbedos_commissioning.md → .../platforms/mbedos/mbedos_commissioning.md
@@ -58,7 +58,7 @@ To make provisioning possible and to control the Matter device from your Android
 based smartphone, you must first build and install the CHIPTool application.
 
 To build the CHIPTool application for your smartphone, read
-[Android building guide](android_building.md).
+[Android building guide](../android/android_building.md).
 
 After building, install the application by completing the following steps:
 
@@ -154,7 +154,7 @@ brightness between 0-255.
 If **Lighting LED** is available then brightness change can be observed.
 
 > For more details about Android CHIPTool please visit
-> [CHIPTool](../../examples/android/CHIPTool/README.md)
+> [CHIPTool](../../../examples/android/CHIPTool/README.md)
 
 ## POSIX CLI CHIPTool
 
@@ -164,7 +164,7 @@ To make provisioning possible and to control the Matter device from Linux-based
 device, you can build and run the Matter Client example application on it.
 
 To build the POSIX CLI CHIPTool application check the guide
-[POSIX CLI guide](../../examples/chip-tool/README.md).
+[POSIX CLI guide](../../../examples/chip-tool/README.md).
 
 ### Device commissioning for CLI
 
@@ -196,7 +196,7 @@ For example:
 The client will send a single command packet and then exit.
 
 > For more details about POSIX CLI CHIPTool please visit
-> [POSIX CLI CHIPTool](../../examples/chip-tool/README.md)
+> [POSIX CLI CHIPTool](../../../examples/chip-tool/README.md)
 
 ## Python Device Controller
 
@@ -206,7 +206,7 @@ To make provisioning possible and to control the Matter device with Python
 application, you can build and run the Python CHIP controller.
 
 To build and install the Python Device Controller application check the guide
-[Python Device Controller guide](python_chip_controller_building.md).
+[Python Device Controller guide](../../development_controllers/chip-repl/python_chip_controller_building.md).
 
 ### Device commissioning for Python Device Controller
 

diff --git a/docs/guides/mbedos_platform_overview.md → ...tforms/mbedos/mbedos_platform_overview.md b/docs/guides/mbedos_platform_overview.md → ...tforms/mbedos/mbedos_platform_overview.md
@@ -85,11 +85,11 @@ needed to perform communication through the Matter stack.
 Sample Matter applications are provided for the Mbed OS platform. They can be
 used to speed up development:
 
--   [shell](../../examples/shell/mbed/README.md)
--   [all-clusters-app](../../examples/all-clusters-app/mbed/README.md)
--   [lock-app](../../examples/lock-app/mbed/README.md)
--   [lighting-app](../../examples/lighting-app/mbed/README.md)
--   [pigweed-app](../../examples/pigweed-app/mbed/README.md)
+-   [shell](../../../examples/shell/mbed/README.md)
+-   [all-clusters-app](../../../examples/all-clusters-app/mbed/README.md)
+-   [lock-app](../../../examples/lock-app/mbed/README.md)
+-   [lighting-app](../../../examples/lighting-app/mbed/README.md)
+-   [pigweed-app](../../../examples/pigweed-app/mbed/README.md)
 
 ### Example configuration
 

diff --git a/...s/images/CHIPTool_device_commissioned.png → ...f/images/CHIPTool_device_commissioned.png b/...s/images/CHIPTool_device_commissioned.png → ...f/images/CHIPTool_device_commissioned.png
diff --git a/...er_nrfconnect_overview_simplified_ncs.svg → ...er_nrfconnect_overview_simplified_ncs.svg b/...er_nrfconnect_overview_simplified_ncs.svg → ...er_nrfconnect_overview_simplified_ncs.svg
diff --git a/...mages/nrfconnect_android_connectivity.png → ...mages/nrfconnect_android_connectivity.png b/...mages/nrfconnect_android_connectivity.png → ...mages/nrfconnect_android_connectivity.png
diff --git a/docs/platforms/nrf/index.md b/docs/platforms/nrf/index.md
@@ -0,0 +1,16 @@
+# NRF
+
+```{toctree}
+:glob:
+:maxdepth: 1
+:hidden:
+
+*
+```
+
+[Android Commissioning](./nrfconnect_android_commissioning.md)
+[Examples CLI](./nrfconnect_examples_cli.md)
+[Examples configuration](./nrfconnect_examples_configuration.md)
+[Examples Software update](./nrfconnect_examples_software_update.md)
+[Factory data](./nrfconnect_factory_data_configuration.md)
+[Platform overview](./nrfconnect_platform_overview.md)