From 80d7e840b277eaf87a535481f8ef3f2e580be282 Mon Sep 17 00:00:00 2001 From: Mihai Ignat <50373067+mihai-ignat@users.noreply.github.com> Date: Thu, 25 Apr 2024 14:38:24 +0300 Subject: [PATCH] [NXP][docs] Put all NXP guides in nxp folder and update paths (#33092) * [NXP][docs] Put all NXP guides in nxp folder and update paths * Restyled by prettier-markdown --------- Co-authored-by: Restyled.io --- docs/guides/README.md | 3 +-- docs/guides/darwin.md | 2 +- docs/guides/index.md | 5 ++--- docs/guides/nxp/README.md | 14 +++++++++++++ .../{ => nxp}/nxp_imx8m_linux_examples.md | 16 +++++++-------- .../nxp_k32w_android_commissioning.md | 20 +++++++++---------- .../{ => nxp}/nxp_manufacturing_flow.md | 0 .../nxp_rw61x_ota_software_update.md | 10 +++++----- .../nxp_zephyr_ota_software_update.md | 4 ++-- examples/air-purifier-app/linux/README.md | 3 ++- .../air-quality-sensor-app/linux/README.md | 3 ++- .../nxp/linux-imx/imx8m/README.md | 4 ++-- .../all-clusters-app/nxp/rt/rw61x/README.md | 8 ++++---- .../nxp/linux-imx/imx8m/README.md | 4 ++-- .../nxp/k32w/k32w0/README.md | 2 +- .../nxp/k32w/k32w1/README.md | 2 +- examples/dishwasher-app/linux/README.md | 3 ++- .../energy-management-app/linux/README.md | 3 ++- examples/lighting-app/linux/README.md | 3 ++- .../lighting-app/nxp/k32w/k32w0/README.md | 2 +- .../lighting-app/nxp/k32w/k32w1/README.md | 2 +- .../nxp/linux-imx/imx8m/README.md | 4 ++-- examples/refrigerator-app/linux/README.md | 3 ++- .../thermostat/nxp/linux-imx/imx8m/README.md | 4 ++-- examples/thermostat/nxp/linux-se05x/README.md | 4 ++-- .../nxp/factory_data_generator/README.md | 2 +- 26 files changed, 74 insertions(+), 56 deletions(-) create mode 100644 docs/guides/nxp/README.md rename docs/guides/{ => nxp}/nxp_imx8m_linux_examples.md (95%) rename docs/guides/{ => nxp}/nxp_k32w_android_commissioning.md (94%) rename docs/guides/{ => nxp}/nxp_manufacturing_flow.md (100%) rename docs/guides/{ => nxp}/nxp_rw61x_ota_software_update.md (96%) rename docs/guides/{ => nxp}/nxp_zephyr_ota_software_update.md (99%) diff --git a/docs/guides/README.md b/docs/guides/README.md index dbdda1bba07de4..e9a42a15861648 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -18,8 +18,7 @@ - [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 - Android Commissioning](./nxp_k32w_android_commissioning.md) -- [NXP - Linux Examples](./nxp_imx8m_linux_examples.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) diff --git a/docs/guides/darwin.md b/docs/guides/darwin.md index 0b312807e3457f..4a9a8da939952e 100644 --- a/docs/guides/darwin.md +++ b/docs/guides/darwin.md @@ -259,7 +259,7 @@ Example: - [mbedOS](/examples/all-clusters-app/mbed/README.md) - [nRF Connect All Clusters](./nrfconnect_examples_configuration.md) - [nRF Connect Pump](/examples/pump-app/nrfconnect/README.md) -- [NXP Examples](./nxp_imx8m_linux_examples.md) +- [NXP Examples](./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) diff --git a/docs/guides/index.md b/docs/guides/index.md index 2a5d3a64f5afe7..7ec0ec61a3cc69 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -10,6 +10,7 @@ and features. * esp32/README +nxp/README ti/ti_platform_overview ``` @@ -34,9 +35,7 @@ ti/ti_platform_overview - [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 - Android Commissioning](./nxp_k32w_android_commissioning.md) -- [NXP - Linux Examples](./nxp_imx8m_linux_examples.md) -- [NXP - Manufacturing Data](./nxp_manufacturing_flow.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) diff --git a/docs/guides/nxp/README.md b/docs/guides/nxp/README.md new file mode 100644 index 00000000000000..be225ac938f7b5 --- /dev/null +++ b/docs/guides/nxp/README.md @@ -0,0 +1,14 @@ +```{toctree} +:glob: +:maxdepth: 1 + +* +``` + +# NXP Getting Started Guide + +- [NXP - Android Commissioning](nxp_k32w_android_commissioning.md) +- [NXP - Linux Examples](nxp_imx8m_linux_examples.md) +- [NXP - Manufacturing Data](nxp_manufacturing_flow.md) +- [NXP - RW61x OTA Software Update Guide](nxp_rw61x_ota_software_update.md) +- [NXP - Zephyr OTA Software Update Guide](nxp_zephyr_ota_software_update.md) diff --git a/docs/guides/nxp_imx8m_linux_examples.md b/docs/guides/nxp/nxp_imx8m_linux_examples.md similarity index 95% rename from docs/guides/nxp_imx8m_linux_examples.md rename to docs/guides/nxp/nxp_imx8m_linux_examples.md index 6b1ad2b8f6c4bd..4ff8ded6a53515 100644 --- a/docs/guides/nxp_imx8m_linux_examples.md +++ b/docs/guides/nxp/nxp_imx8m_linux_examples.md @@ -4,11 +4,11 @@ This document describes how to build below Linux examples with the NXP embedded Linux Yocto SDK and then run the output executable files on the **NXP i.MX 8M** **Mini EVK** development board. -- [CHIP Linux All-clusters Example](../../examples/all-clusters-app/linux/README.md) -- [CHIP Linux Lighting Example](../../examples/lighting-app/linux/README.md) +- [CHIP Linux All-clusters Example](../../../examples/all-clusters-app/linux/README.md) +- [CHIP Linux Lighting Example](../../../examples/lighting-app/linux/README.md) - [CHIP Linux Thermostat Example](https://github.com/project-chip/connectedhomeip/tree/master/examples/thermostat/linux) -- [CHIP Linux CHIP-tool Example](../../examples/chip-tool/README.md) -- [CHIP Linux OTA-provider Example](../../examples/ota-provider-app/linux/README.md) +- [CHIP Linux CHIP-tool Example](../../../examples/chip-tool/README.md) +- [CHIP Linux OTA-provider Example](../../../examples/ota-provider-app/linux/README.md) This document has been tested on: @@ -234,8 +234,8 @@ Thermostat-app is used as an example below. In order to test the CHIP protocol functions, another device on the same network is needed to run the - [ChipDeviceController](../../src/controller/python) tool to communicate with - the **i.MX 8M Mini EVK**. + [ChipDeviceController](../../../src/controller/python) tool to communicate + with the **i.MX 8M Mini EVK**. The ChipDeviceController can be a laptop / workstation. Bluetooth functionality is mandatory on this device. @@ -252,7 +252,7 @@ Thermostat-app is used as an example below. - Boot up Ubuntu on the Raspberry Pi - Clone this connectedhomeip project - Follow Python ChipDeviceController - [README.md](../../src/controller/python/README.md) document. Refer to + [README.md](../../../src/controller/python/README.md) document. Refer to the "Building and installing" part to build the tool. - Running @@ -283,7 +283,7 @@ Thermostat-app is used as an example below. /home/root/thermostat-app --ble-device 0 --wifi # The bluetooth device used is hci0 and support wifi network ``` - - Run [ChipDeviceController](../../src/controller/python) on the + - Run [ChipDeviceController](../../../src/controller/python) on the controller device to communicate with **i.MX 8M Mini EVK** running the example. diff --git a/docs/guides/nxp_k32w_android_commissioning.md b/docs/guides/nxp/nxp_k32w_android_commissioning.md similarity index 94% rename from docs/guides/nxp_k32w_android_commissioning.md rename to docs/guides/nxp/nxp_k32w_android_commissioning.md index b39a2f2afd2c8c..6d872f5f7ba268 100644 --- a/docs/guides/nxp_k32w_android_commissioning.md +++ b/docs/guides/nxp/nxp_k32w_android_commissioning.md @@ -1,8 +1,8 @@ # Commissioning NXP K32W using Android CHIPTool This article describes how to use -[CHIPTool](../../examples/android/CHIPTool/README.md) for Android smartphones to -commission an NXP K32W061 DK6 running +[CHIPTool](../../../examples/android/CHIPTool/README.md) for Android smartphones +to commission an NXP K32W061 DK6 running [NXP K32W Light Example Application](#building-and-programming-nxp-k32w-light-example-application) onto a CHIP-enabled Thread network. @@ -47,7 +47,7 @@ The following diagram shows the connectivity between network components required to allow communication between devices running the CHIPTool and Light applications: -![nxp_hw_connectivity](../../examples/platform/nxp/k32w/k32w0/doc/images/nxp_hw_connectivity.JPG) +![nxp_hw_connectivity](../../../examples/platform/nxp/k32w/k32w0/doc/images/nxp_hw_connectivity.JPG)
@@ -348,7 +348,7 @@ To make your PC work as a Thread Border Router, complete the following tasks: ## Building and programming NXP K32W Light Example Application See -[NXP K32W Light Example Application README](../../examples/lighting-app/nxp/k32w/k32w0/README.md) +[NXP K32W Light Example Application README](../../../examples/lighting-app/nxp/k32w/k32w0/README.md) to learn how to build and program the light example onto an K32W061 DK6.
@@ -356,7 +356,7 @@ to learn how to build and program the light example onto an K32W061 DK6. ## Building and installing Android CHIPTool To build the CHIPTool application for your smartphone, read -[Android CHIPTool README](../../examples/android/CHIPTool/README.md). +[Android CHIPTool README](../../../examples/android/CHIPTool/README.md). After building, install the application by completing the following steps: @@ -396,7 +396,7 @@ CHIPTool is now ready to be used for commissioning. 3. Navigate to the _Form_ tab then push the _Form_ button using the default parameters: - ![nxp_form_nwk](../../examples/platform/nxp/k32w/k32w0/doc/images/form_web.JPG) + ![nxp_form_nwk](../../../examples/platform/nxp/k32w/k32w0/doc/images/form_web.JPG) 4. The message _Form operation is successful_ should be display after a few seconds. @@ -430,7 +430,7 @@ To prepare the accessory device for commissioning, complete the following steps: 1. Make sure that JP4 and JP7 jumpers are in leftmost position and a mini-USB cable is connected between the LPC connector and PC - ![nxp_connectors](../../examples/platform/nxp/k32w/k32w0/doc/images/k32w-dk6-connectors.jpg) + ![nxp_connectors](../../../examples/platform/nxp/k32w/k32w0/doc/images/k32w-dk6-connectors.jpg) 2. Use a terminal emulator (e.g.: Putty) to connect to the UART console of the accessory device. Use a baudrate of 115200. @@ -466,14 +466,14 @@ section, complete the following steps: progress with scanning, connection, and pairing. At the end of this process, the Thread network settings screen appears. - ![chiptool_main_screen](../../examples/platform/nxp/k32w/k32w0/doc/images/chiptool_main_screen.png) + ![chiptool_main_screen](../../../examples/platform/nxp/k32w/k32w0/doc/images/chiptool_main_screen.png) 6. In the Thread network settings screen, use the default settings and tap the _SAVE NETWORK_ button to send a Thread provisioning message to the accessory device. You will see the "Network provisioning completed" message when the accessory device successfully joins the Thread network. - ![chiptool_credentials](../../examples/platform/nxp/k32w/k32w0/doc/images/thread_credentials.png) + ![chiptool_credentials](../../../examples/platform/nxp/k32w/k32w0/doc/images/thread_credentials.png)
@@ -483,7 +483,7 @@ section, complete the following steps: the provisioning is completed successfully and you are connected to the device. - ![on_off_cluster.png](../../examples/platform/nxp/k32w/k32w0/doc/images/on_off_cluster.png) + ![on_off_cluster.png](../../../examples/platform/nxp/k32w/k32w0/doc/images/on_off_cluster.png) 2. Verify that the text box on the screen is not empty and contains the IPv6 address of the accessory device. diff --git a/docs/guides/nxp_manufacturing_flow.md b/docs/guides/nxp/nxp_manufacturing_flow.md similarity index 100% rename from docs/guides/nxp_manufacturing_flow.md rename to docs/guides/nxp/nxp_manufacturing_flow.md diff --git a/docs/guides/nxp_rw61x_ota_software_update.md b/docs/guides/nxp/nxp_rw61x_ota_software_update.md similarity index 96% rename from docs/guides/nxp_rw61x_ota_software_update.md rename to docs/guides/nxp/nxp_rw61x_ota_software_update.md index cdabf5e012da96..1543b2f94402cf 100644 --- a/docs/guides/nxp_rw61x_ota_software_update.md +++ b/docs/guides/nxp/nxp_rw61x_ota_software_update.md @@ -89,7 +89,7 @@ J-Link > erase 0x8000000, 0x88a0000 - Using MCUXPresso, import the `mcuboot_opensource` demo example from the SDK previously downloaded. The example can be found under the `ota_examples` folder. - ![mcuboot_demo](../../examples/platform/nxp/rt/rw61x/doc/images/mcuboot_demo.PNG) + ![mcuboot_demo](../../../examples/platform/nxp/rt/rw61x/doc/images/mcuboot_demo.PNG) - Before building the demo example, it should be specified that the application to be run by the bootloader is monolithic. As a result, only one image will be upgraded by the bootloader. This can be done by defining @@ -99,7 +99,7 @@ J-Link > erase 0x8000000, 0x88a0000 Right click on the Project -> Properties -> C/C++ Build -> Settings -> Tool Settings -> MCU C Compiler -> Preprocessor -> Add "MONOLITHIC_APP=1" in the Defined Symbols ``` -![rw610_mcuboot_monolithic](../../examples/platform/nxp/rt/rw61x/doc/images/mcuboot_monolithic_app.PNG) +![rw610_mcuboot_monolithic](../../../examples/platform/nxp/rt/rw61x/doc/images/mcuboot_monolithic_app.PNG) - Build the demo example project. @@ -149,7 +149,7 @@ The image must have the following format : signature, the upgrade type, the swap status... The all-clusters application can be generated using the instructions from the -[README.md 'Building'](../../examples/all-clusters-app/nxp/rt/rw61x/README.md#building) +[README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rw61x/README.md#building) section. The application is automatically linked to be executed from the primary image partition, taking into consideration the offset imposed by mcuboot. @@ -242,8 +242,8 @@ instructions below describe the procedure step-by-step. Setup example : -- [Chip-tool](../../examples/chip-tool/README.md) application running on the - RPi. +- [Chip-tool](../../../examples/chip-tool/README.md) application running on + the RPi. - OTA Provider application built on the same RPi (as explained below). - RW61x board programmed with the example application (with the instructions above). diff --git a/docs/guides/nxp_zephyr_ota_software_update.md b/docs/guides/nxp/nxp_zephyr_ota_software_update.md similarity index 99% rename from docs/guides/nxp_zephyr_ota_software_update.md rename to docs/guides/nxp/nxp_zephyr_ota_software_update.md index a36ac3281cb116..314765aaa4d7c6 100644 --- a/docs/guides/nxp_zephyr_ota_software_update.md +++ b/docs/guides/nxp/nxp_zephyr_ota_software_update.md @@ -178,8 +178,8 @@ Update. The instructions below describes the procedure step-by-step. Setup example : -- [Chip-tool](../../examples/chip-tool/README.md) application running on the - RPi. +- [Chip-tool](../../../examples/chip-tool/README.md) application running on + the RPi. - OTA Provider application built on the same RPi (as explained below). - Board programmed with the example application (with the instructions above). diff --git a/examples/air-purifier-app/linux/README.md b/examples/air-purifier-app/linux/README.md index d2352bca201e1a..2d771bdf5b5ff4 100644 --- a/examples/air-purifier-app/linux/README.md +++ b/examples/air-purifier-app/linux/README.md @@ -11,7 +11,8 @@ Temperature Sensor and Endpoint 5 is a Thermostat. To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../docs/guides/nxp_imx8m_linux_examples.md) for details. +[README document](../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) for +details.
diff --git a/examples/air-quality-sensor-app/linux/README.md b/examples/air-quality-sensor-app/linux/README.md index b1c2e92461d8f0..ef90a4bd23df9f 100644 --- a/examples/air-quality-sensor-app/linux/README.md +++ b/examples/air-quality-sensor-app/linux/README.md @@ -7,7 +7,8 @@ for Raspberry Pi Desktop 20.10 (aarch64)** To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../docs/guides/nxp_imx8m_linux_examples.md) for details. +[README document](../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) for +details.
diff --git a/examples/all-clusters-app/nxp/linux-imx/imx8m/README.md b/examples/all-clusters-app/nxp/linux-imx/imx8m/README.md index 9a90a11e0dccc4..e20ff1065d3dfb 100644 --- a/examples/all-clusters-app/nxp/linux-imx/imx8m/README.md +++ b/examples/all-clusters-app/nxp/linux-imx/imx8m/README.md @@ -1,4 +1,4 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../../../docs/guides/nxp_imx8m_linux_examples.md) for -details. +[README document](../../../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) +for details. diff --git a/examples/all-clusters-app/nxp/rt/rw61x/README.md b/examples/all-clusters-app/nxp/rt/rw61x/README.md index 8a6889909dffa3..bdec2c58956274 100644 --- a/examples/all-clusters-app/nxp/rt/rw61x/README.md +++ b/examples/all-clusters-app/nxp/rt/rw61x/README.md @@ -139,16 +139,16 @@ Optional GN options that can be added when building an application: - To build with the option to have Matter certificates/keys pre-loaded in a specific flash area the argument `chip_with_factory_data=1` must be added to the _gn gen_ command. (for more information see - [Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). + [Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp/nxp_manufacturing_flow.md). - To build the application with the OTA Requestor enabled, the arguments `chip_enable_ota_requestor=true no_mcuboot=false` must be added to the _gn gen_ command. (More information about the OTA Requestor feature in - [OTA Requestor README](../../../../../docs/guides/nxp_rw61x_ota_software_update.md) + [OTA Requestor README](../../../../../docs/guides/nxp/nxp_rw61x_ota_software_update.md) ## Manufacturing data See -[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md) +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp/nxp_manufacturing_flow.md) Other comments: @@ -374,4 +374,4 @@ Done Over-The-Air software updates are supported with the RW61x all-clusters example. The process to follow in order to perform a software update is described in the dedicated guide -['Matter Over-The-Air Software Update with NXP RW61x example applications'](../../../../../docs/guides/nxp_rw61x_ota_software_update.md). +['Matter Over-The-Air Software Update with NXP RW61x example applications'](../../../../../docs/guides/nxp/nxp_rw61x_ota_software_update.md). diff --git a/examples/all-clusters-minimal-app/nxp/linux-imx/imx8m/README.md b/examples/all-clusters-minimal-app/nxp/linux-imx/imx8m/README.md index 9a90a11e0dccc4..e20ff1065d3dfb 100644 --- a/examples/all-clusters-minimal-app/nxp/linux-imx/imx8m/README.md +++ b/examples/all-clusters-minimal-app/nxp/linux-imx/imx8m/README.md @@ -1,4 +1,4 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../../../docs/guides/nxp_imx8m_linux_examples.md) for -details. +[README document](../../../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) +for details. diff --git a/examples/contact-sensor-app/nxp/k32w/k32w0/README.md b/examples/contact-sensor-app/nxp/k32w/k32w0/README.md index b7ec329d7650d1..5ad31921b665ae 100644 --- a/examples/contact-sensor-app/nxp/k32w/k32w0/README.md +++ b/examples/contact-sensor-app/nxp/k32w/k32w0/README.md @@ -348,7 +348,7 @@ Please use the following build args: ## Manufacturing data See -[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp/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/contact-sensor-app/nxp/k32w/k32w1/README.md b/examples/contact-sensor-app/nxp/k32w/k32w1/README.md index 5079e01c6e2400..f3896a01b8362e 100644 --- a/examples/contact-sensor-app/nxp/k32w/k32w1/README.md +++ b/examples/contact-sensor-app/nxp/k32w/k32w1/README.md @@ -185,7 +185,7 @@ using Fibonacci backoff for retries pacing. Use `chip_with_factory_data=1` in the gn build command to enable factory data. For a full guide on manufacturing flow, please see -[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp/nxp_manufacturing_flow.md). ## Flashing diff --git a/examples/dishwasher-app/linux/README.md b/examples/dishwasher-app/linux/README.md index 3c8df646ecd060..2d3b461386395d 100644 --- a/examples/dishwasher-app/linux/README.md +++ b/examples/dishwasher-app/linux/README.md @@ -7,7 +7,8 @@ for Raspberry Pi Desktop 20.10 (aarch64)** To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../docs/guides/nxp_imx8m_linux_examples.md) for details. +[README document](../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) for +details.
diff --git a/examples/energy-management-app/linux/README.md b/examples/energy-management-app/linux/README.md index 424ef46d58e259..f91d341915ccd8 100644 --- a/examples/energy-management-app/linux/README.md +++ b/examples/energy-management-app/linux/README.md @@ -7,7 +7,8 @@ for Raspberry Pi Desktop 20.10 (aarch64)** To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../docs/guides/nxp_imx8m_linux_examples.md) for details. +[README document](../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) for +details.
diff --git a/examples/lighting-app/linux/README.md b/examples/lighting-app/linux/README.md index ff2c9b1bf50611..e41799a70dc60d 100644 --- a/examples/lighting-app/linux/README.md +++ b/examples/lighting-app/linux/README.md @@ -7,7 +7,8 @@ Raspberry Pi Desktop 20.10 (aarch64)** To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../docs/guides/nxp_imx8m_linux_examples.md) for details. +[README document](../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) for +details.
diff --git a/examples/lighting-app/nxp/k32w/k32w0/README.md b/examples/lighting-app/nxp/k32w/k32w0/README.md index af43002f21c65a..106a614191c5f0 100644 --- a/examples/lighting-app/nxp/k32w/k32w0/README.md +++ b/examples/lighting-app/nxp/k32w/k32w0/README.md @@ -323,7 +323,7 @@ Please use the following build args: ## Manufacturing data See -[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp/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/k32w1/README.md b/examples/lighting-app/nxp/k32w/k32w1/README.md index c44c73a1ecc946..3bf2ab8105481b 100644 --- a/examples/lighting-app/nxp/k32w/k32w1/README.md +++ b/examples/lighting-app/nxp/k32w/k32w1/README.md @@ -187,7 +187,7 @@ control** cluster Use `chip_with_factory_data=1` in the gn build command to enable factory data. For a full guide on manufacturing flow, please see -[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp/nxp_manufacturing_flow.md). ## Flashing diff --git a/examples/lighting-app/nxp/linux-imx/imx8m/README.md b/examples/lighting-app/nxp/linux-imx/imx8m/README.md index 9a90a11e0dccc4..e20ff1065d3dfb 100644 --- a/examples/lighting-app/nxp/linux-imx/imx8m/README.md +++ b/examples/lighting-app/nxp/linux-imx/imx8m/README.md @@ -1,4 +1,4 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../../../docs/guides/nxp_imx8m_linux_examples.md) for -details. +[README document](../../../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) +for details. diff --git a/examples/refrigerator-app/linux/README.md b/examples/refrigerator-app/linux/README.md index fc51f2fc39d6d6..a8adfe03a792fb 100644 --- a/examples/refrigerator-app/linux/README.md +++ b/examples/refrigerator-app/linux/README.md @@ -7,7 +7,8 @@ for Raspberry Pi Desktop 20.10 (aarch64)** To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../docs/guides/nxp_imx8m_linux_examples.md) for details. +[README document](../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) for +details.
diff --git a/examples/thermostat/nxp/linux-imx/imx8m/README.md b/examples/thermostat/nxp/linux-imx/imx8m/README.md index 9a90a11e0dccc4..e20ff1065d3dfb 100644 --- a/examples/thermostat/nxp/linux-imx/imx8m/README.md +++ b/examples/thermostat/nxp/linux-imx/imx8m/README.md @@ -1,4 +1,4 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../../../docs/guides/nxp_imx8m_linux_examples.md) for -details. +[README document](../../../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) +for details. diff --git a/examples/thermostat/nxp/linux-se05x/README.md b/examples/thermostat/nxp/linux-se05x/README.md index 9a90a11e0dccc4..e20ff1065d3dfb 100644 --- a/examples/thermostat/nxp/linux-se05x/README.md +++ b/examples/thermostat/nxp/linux-se05x/README.md @@ -1,4 +1,4 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** **EVK**, see the associated -[README document](../../../../../docs/guides/nxp_imx8m_linux_examples.md) for -details. +[README document](../../../../../docs/guides/nxp/nxp_imx8m_linux_examples.md) +for details. diff --git a/scripts/tools/nxp/factory_data_generator/README.md b/scripts/tools/nxp/factory_data_generator/README.md index 38f65d4b7cbaef..0aacaeb81a29b6 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 For usage of the tool, please see -[Guide for writing manufacturing data on NXP devices](../../../../docs/guides/nxp_manufacturing_flow.md). +[Guide for writing manufacturing data on NXP devices](../../../../docs/guides/nxp/nxp_manufacturing_flow.md). ## Tool implementation