From 15836357e8c3d6c25d31c2b9ce935cead8bbe951 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc <41291385+greg-fer@users.noreply.github.com> Date: Fri, 28 Apr 2023 08:14:09 +0200 Subject: [PATCH] doc: tools: add tools section and pages (#26262) * doc: tools: add tools section and pages Added tools section and pages in documentation. This adds readmies for chip-cert and spake2p to the doc pool. Signed-off-by: Grzegorz Ferenc * doc: move NXP manufacturing guide doc to fix links Moved the NXP manufacturing data guide into docs/guides. Added the guide to the doc pool and updated links. Signed-off-by: Grzegorz Ferenc * Restyled by prettier-markdown --------- Signed-off-by: Grzegorz Ferenc Co-authored-by: Restyled.io --- docs/conf.py | 5 ++ docs/guides/index.md | 1 + .../guides/nxp_manufacturing_flow.md | 2 +- docs/index.md | 1 + docs/tools/index.md | 63 +++++++++++++++++++ .../nxp/k32w/k32w0/README.md | 2 +- .../lighting-app/nxp/k32w/k32w0/README.md | 2 +- examples/lock-app/nxp/k32w/k32w0/README.md | 2 +- .../nxp/factory_data_generator/README.md | 4 +- scripts/tools/nxp/ota/README.md | 2 +- scripts/tools/silabs/README.md | 2 +- src/tools/chip-cert/README.md | 2 +- 12 files changed, 79 insertions(+), 9 deletions(-) rename examples/platform/nxp/doc/manufacturing_flow.md => docs/guides/nxp_manufacturing_flow.md (99%) create mode 100644 docs/tools/index.md diff --git a/docs/conf.py b/docs/conf.py index bf83e215be05b5..1f2f0d96cf74e8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,6 +32,9 @@ "examples/thermostat/nxp/linux-se05x/README.md", "examples/common/m5stack-tft/repo", "docs/guides/README.md", + "scripts/tools/memory/memdf/README.md", + "scripts/tools/memory/platform/README.md", + "scripts/tools/memory/README-GitHub-CI.md", ] @@ -69,6 +72,8 @@ (MATTER_BASE, "examples/**/*.png"), (MATTER_BASE, "examples/**/*.jpg"), (MATTER_BASE, "examples/**/*.JPG"), + (MATTER_BASE, "src/tools/**/*.md"), + (MATTER_BASE, "scripts/tools/**/*.md"), ] external_content_link_prefixes = [ "src/", diff --git a/docs/guides/index.md b/docs/guides/index.md index c6a488f8e8add5..5d93bbb9b012ae 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -34,6 +34,7 @@ esp32/README - [nRF Connect - Software Update](./nrfconnect_examples_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) - [Silicon Labs - Documentation](https://github.com/SiliconLabs/matter#readme) - [Silicon Labs - Building](./silabs_efr32_building.md) - [Silicon Labs - Software Update](./silabs_efr32_software_update.md) diff --git a/examples/platform/nxp/doc/manufacturing_flow.md b/docs/guides/nxp_manufacturing_flow.md similarity index 99% rename from examples/platform/nxp/doc/manufacturing_flow.md rename to docs/guides/nxp_manufacturing_flow.md index bfa064407ea229..019cfa67a38680 100644 --- a/examples/platform/nxp/doc/manufacturing_flow.md +++ b/docs/guides/nxp_manufacturing_flow.md @@ -2,7 +2,7 @@ orphan: true --- -## Manufacturing data +# NXP manufacturing data guide By default, the example application is configured to use generic test certificates and provisioning data embedded with the application code. It is diff --git a/docs/index.md b/docs/index.md index 690386ab19c636..cd865b4d31027e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,6 +13,7 @@ discussion/index guides/index style/index examples/index +tools/index BUG_REPORT code_generation ERROR_CODES diff --git a/docs/tools/index.md b/docs/tools/index.md new file mode 100644 index 00000000000000..003573ed5ebb14 --- /dev/null +++ b/docs/tools/index.md @@ -0,0 +1,63 @@ +# Tools + +The Matter SDK provides tools that allow you to generate and manage different +aspects of the Matter development. + +## C++ tools + +Source files for these tools are located at `src/tools`. + +```{toctree} +:glob: +:maxdepth: 1 + +../src/tools/chip-cert/README +../src/tools/spake2p/README + +``` + +## Python tools + +Source files for these tools are located at `scripts/tools`. + +### General tools + +```{toctree} +:glob: +:maxdepth: 1 + +../scripts/tools/memory/README +../scripts/tools/spake2p/README + +``` + +### NXP tools + +```{toctree} +:glob: +:maxdepth: 1 + +../scripts/tools/nxp/factory_data_generator/README +../scripts/tools/nxp/ota/README + +``` + +### Silabs tools + +```{toctree} +:glob: +:maxdepth: 1 + +../scripts/tools/silabs/README + +``` + +### Telink tools + +```{toctree} +:glob: +:maxdepth: 1 + +../scripts/tools/telink/readme + +``` diff --git a/examples/contact-sensor-app/nxp/k32w/k32w0/README.md b/examples/contact-sensor-app/nxp/k32w/k32w0/README.md index af446f80a6bd99..54854b41613622 100644 --- a/examples/contact-sensor-app/nxp/k32w/k32w0/README.md +++ b/examples/contact-sensor-app/nxp/k32w/k32w0/README.md @@ -241,7 +241,7 @@ The resulting output file can be found in out/debug/chip-k32w0x-contact-example. ## Manufacturing data See -[Guide for writing manufacturing data on NXP devices](../../../../platform/nxp/doc/manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). There are factory data generated binaries available in examples/platform/nxp/k32w/k32w0/scripts/demo_generated_factory_data folder. diff --git a/examples/lighting-app/nxp/k32w/k32w0/README.md b/examples/lighting-app/nxp/k32w/k32w0/README.md index 7de06266209374..1bebb18a50e650 100644 --- a/examples/lighting-app/nxp/k32w/k32w0/README.md +++ b/examples/lighting-app/nxp/k32w/k32w0/README.md @@ -254,7 +254,7 @@ The resulting output file can be found in out/debug/chip-k32w0x-light-example. ## Manufacturing data See -[Guide for writing manufacturing data on NXP devices](../../../../platform/nxp/doc/manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). There are factory data generated binaries available in examples/platform/nxp/k32w/k32w0/scripts/demo_generated_factory_data folder. diff --git a/examples/lock-app/nxp/k32w/k32w0/README.md b/examples/lock-app/nxp/k32w/k32w0/README.md index d788a785016c1e..3a2f027e447ab8 100644 --- a/examples/lock-app/nxp/k32w/k32w0/README.md +++ b/examples/lock-app/nxp/k32w/k32w0/README.md @@ -227,7 +227,7 @@ The resulting output file can be found in out/debug/chip-k32w0x-lock-example. ## Manufacturing data See -[Guide for writing manufacturing data on NXP devices](../../../../platform/nxp/doc/manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). There are factory data generated binaries available in examples/platform/nxp/k32w/k32w0/scripts/demo_generated_factory_data folder. diff --git a/scripts/tools/nxp/factory_data_generator/README.md b/scripts/tools/nxp/factory_data_generator/README.md index 74380f0ff8d502..38f65d4b7cbaef 100644 --- a/scripts/tools/nxp/factory_data_generator/README.md +++ b/scripts/tools/nxp/factory_data_generator/README.md @@ -1,7 +1,7 @@ -## NXP Factory Data Generator +# NXP Factory Data Generator For usage of the tool, please see -[Guide for writing manufacturing data on NXP devices](../../../../examples/platform/nxp/doc/manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../docs/guides/nxp_manufacturing_flow.md). ## Tool implementation diff --git a/scripts/tools/nxp/ota/README.md b/scripts/tools/nxp/ota/README.md index 923e9a5dfe1797..e1848a007f3441 100644 --- a/scripts/tools/nxp/ota/README.md +++ b/scripts/tools/nxp/ota/README.md @@ -116,7 +116,7 @@ private: update OTA image. If the `PAA` changes, make sure to generate the new certificates using the new `PAA` (which is only used by the controller, e.g. `chip-tool`). Please see the -[manufacturing flow guide](../../../../examples/platform/nxp/doc/manufacturing_flow.md) +[manufacturing flow guide](../../../../docs/guides/nxp_manufacturing_flow.md) for generating new certificates. Example of OTA image generation with factory data and application update (using diff --git a/scripts/tools/silabs/README.md b/scripts/tools/silabs/README.md index e042606b1ff472..0d24f1af4870c2 100644 --- a/scripts/tools/silabs/README.md +++ b/scripts/tools/silabs/README.md @@ -1,4 +1,4 @@ -#`FactoryDataProvider` for EFR32 Matter device +# `FactoryDataProvider` for EFR32 Matter device ## Introduction diff --git a/src/tools/chip-cert/README.md b/src/tools/chip-cert/README.md index 9b2b1fe9bda7ad..400e5307387c4a 100644 --- a/src/tools/chip-cert/README.md +++ b/src/tools/chip-cert/README.md @@ -809,7 +809,7 @@ HELP OPTIONS Print the version and then exit. ``` -#### gen-cd example +#### print-cd example An example of printing a Certificate Declaration (CD), which is provided as a command line argument in a hex format: