Skip to content

Commit

Permalink
doc: tools: add tools section and pages (#26262)
Browse files Browse the repository at this point in the history
* 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 <Grzegorz.Ferenc@nordicsemi.no>

* 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 <Grzegorz.Ferenc@nordicsemi.no>

* Restyled by prettier-markdown

---------

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
Co-authored-by: Restyled.io <commits@restyled.io>
  • Loading branch information
2 people authored and pull[bot] committed Jun 23, 2023
1 parent 12187ab commit 1161487
Show file tree
Hide file tree
Showing 12 changed files with 79 additions and 9 deletions.
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
]


Expand Down Expand Up @@ -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/",
Expand Down
1 change: 1 addition & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ discussion/index
guides/index
style/index
examples/index
tools/index
BUG_REPORT
code_generation
ERROR_CODES
Expand Down
63 changes: 63 additions & 0 deletions docs/tools/index.md
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion examples/contact-sensor-app/nxp/k32w/k32w0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/lighting-app/nxp/k32w/k32w0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/lock-app/nxp/k32w/k32w0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions scripts/tools/nxp/factory_data_generator/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion scripts/tools/nxp/ota/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion scripts/tools/silabs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#`FactoryDataProvider` for EFR32 Matter device
# `FactoryDataProvider` for EFR32 Matter device

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion src/tools/chip-cert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 1161487

Please sign in to comment.