Skip to content

Commit c1046bc

Browse files
[nrf noup] Fixed relative reference in documentation.
1 parent e8ca8d3 commit c1046bc

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

docs/guides/chip_tool_guide.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -759,10 +759,12 @@ against a paired Matter device.
759759
760760
- _<test_name\>_ is the name of the particular test.
761761
762+
762763
See the [Examples](#running-testclusters-test) section for an example of how to
763764
run a test from the test suite.
764765
765-
<hr>
766+
Developer details on how the test suite is structured can be found
767+
[here](https://github.com/project-chip/connectedhomeip/blob/master/src/app/tests/suites/README.md).
766768
767769
### Parsing the setup payload
768770

docs/guides/nrfconnect_factory_data_configuration.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ data stored in the device's flash memory is provided in the CBOR format.
7777
However, it is possible to generate the factory data set without using the nRF
7878
Connect scripts and implement another parser and a factory data accessor. This
7979
is possible if the newly provided implementation is consistent with the
80-
[Factory Data Provider](../../src/platform/nrfconnect/FactoryDataProvider.h).
80+
[Factory Data Provider](https://github.com/project-chip/connectedhomeip/blob/master/src/platform/nrfconnect/FactoryDataProvider.h).
8181
For more information about preparing a factory data accessor, see the section
8282
about
8383
[using own factory data implementation](#using-own-factory-data-implementation).
@@ -222,7 +222,7 @@ device is able to read out parameters,
222222
A Matter device needs a proper factory data partition stored in the flash memory
223223
to read out all required parameters during startup. To simplify the factory data
224224
generation, you can use the
225-
[generate_nrfconnect_chip_factory_data.py](../../scripts/tools/nrfconnect/generate_nrfconnect_chip_factory_data.py)
225+
[generate_nrfconnect_chip_factory_data.py](https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/nrfconnect/generate_nrfconnect_chip_factory_data.py)
226226
Python script to provide all required parameters and generate a human-readable
227227
JSON file.
228228

@@ -605,7 +605,7 @@ multiple of one flash page (for nRF52 and nRF53 SoCs, a single page size equals
605605
606606
See the following code snippet for an example of a factory data partition in the
607607
`pm_static.yml` file. The snippet is based on the `pm_static.yml` file from the
608-
[Lock application example](../../examples/lock-app/nrfconnect/configuration/nrf52840dk_nrf52840/pm_static_dfu.yml)
608+
[Lock application example](https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/nrfconnect/configuration/nrf52840dk_nrf52840/pm_static_dfu.yml)
609609
and uses the nRF52840 DK:
610610
611611
```
@@ -675,7 +675,7 @@ The output will look similar to the following one:
675675
To store the factory data set in the device's persistent storage, convert the
676676
data from the JSON file to its binary representation in the CBOR format. To do
677677
this, use the
678-
[nrfconnect_generate_partition.py](../../scripts/tools/nrfconnect/nrfconnect_generate_partition.py)
678+
[nrfconnect_generate_partition.py](https://github.com/project-chip/connectedhomeip/blob/master/scripts/tools/nrfconnect/nrfconnect_generate_partition.py)
679679
to generate the factory data partition:
680680
681681
1. Navigate to the _connectedhomeip_ root directory
@@ -737,7 +737,7 @@ Alternatively, you can also add `CONFIG_CHIP_FACTORY_DATA_BUILD=y` Kconfig
737737
setting to the example's `prj.conf` file.
738738
739739
Each factory data parameter has a default value. These are described in the
740-
[Kconfig file](../../config/nrfconnect/chip-module/Kconfig). Setting a new value
740+
[Kconfig file](https://github.com/project-chip/connectedhomeip/blob/master/config/nrfconnect/chip-module/Kconfig). Setting a new value
741741
for the factory data parameter can be done either by providing it as a build
742742
argument list or by using interactive Kconfig interfaces.
743743
@@ -760,7 +760,7 @@ Alternatively, you can add the relevant Kconfig option lines to the example's
760760
You can edit all configuration options using the interactive Kconfig interface.
761761
762762
See the
763-
[Configuring nRF Connect examples](../guides/nrfconnect_examples_configuration.md)
763+
[Configuring nRF Connect examples](./nrfconnect_examples_configuration.md)
764764
page for information about how to configure Kconfig options.
765765
766766
In the configuration window, expand the items
@@ -862,22 +862,21 @@ $ west flash
862862
## Using own factory data implementation
863863
864864
The [factory data generation process](#generating-factory-data) described above
865-
is only an example valid for the nRF Connect platform. You can also create a HEX
866-
file containing all components from the
867-
[factory data component table](#factory-data-component-table) in any format and
868-
then implement a parser to read out all parameters and pass them to a provider.
869-
Each manufacturer can implement a factory data set on its own by implementing a
870-
parser and a factory data accessor inside the Matter stack. Use the
871-
[nRF Connect Provider](../../src/platform/nrfconnect/FactoryDataProvider.h) and
872-
[FactoryDataParser](../../src/platform/nrfconnect/FactoryDataParser.h) as
865+
is only an example valid for the nRF Connect platform. You can well create a HEX
866+
file containing all [factory data components](#factory-data-component-table) in
867+
any format and then implement a parser to read out all parameters and pass them
868+
to a provider. Each manufacturer can implement a factory data set on its own by
869+
implementing a parser and a factory data accessor inside the Matter stack. Use
870+
the [nRF Connect Provider](https://github.com/project-chip/connectedhomeip/blob/master/src/platform/nrfconnect/FactoryDataProvider.h)
871+
and [FactoryDataParser](https://github.com/project-chip/connectedhomeip/blob/master/src/platform/nrfconnect/FactoryDataParser.h) as
873872
examples.
874873
875874
You can read the factory data set from the device's flash memory in different
876875
ways, depending on the purpose and the format. In the nRF Connect example, the
877876
factory data is stored in the CBOR format. The device uses the
878-
[Factory Data Parser](../../src/platform/nrfconnect/FactoryDataParser.h) to read
877+
[Factory Data Parser](https://github.com/project-chip/connectedhomeip/blob/master/src/platform/nrfconnect/FactoryDataParser.h) to read
879878
out raw data, decode it, and store it in the `FactoryData` structure. The
880-
[Factor Data Provider](../../src/platform/nrfconnect/FactoryDataProvider.cpp)
879+
[Factor Data Provider](https://github.com/project-chip/connectedhomeip/blob/master/src/platform/nrfconnect/FactoryDataProvider.c)
881880
implementation uses this parser to get all needed factory data parameters and
882881
provide them to the Matter core.
883882

0 commit comments

Comments
 (0)