From 8f583ab0afe948f257aeca4c71367be198034671 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc <41291385+greg-fer@users.noreply.github.com> Date: Mon, 28 Jun 2021 21:01:58 +0200 Subject: [PATCH] doc: nrfconnect: minor style and link fixes (#7949) * doc: nrfconnect: minor style and link fixes Updated style and links to and from nrfconnect guides. Signed-off-by: Grzegorz Ferenc * Restyled by prettier-markdown Co-authored-by: Restyled.io --- docs/guides/nrfconnect_android_commissioning.md | 4 ++-- docs/guides/nrfconnect_examples_cli.md | 4 ++-- docs/guides/nrfconnect_examples_configuration.md | 6 +++--- docs/guides/nrfconnect_examples_software_update.md | 6 +++--- docs/guides/openthread_border_router_pi.md | 7 ++++--- docs/guides/openthread_rcp_nrf_dongle.md | 2 +- examples/shell/nrfconnect/README.md | 10 +++++----- 7 files changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/guides/nrfconnect_android_commissioning.md b/docs/guides/nrfconnect_android_commissioning.md index f7a8b08e4a75e1..8b5b0dcd6f2a95 100644 --- a/docs/guides/nrfconnect_android_commissioning.md +++ b/docs/guides/nrfconnect_android_commissioning.md @@ -136,8 +136,8 @@ To prepare the accessory device for commissioning, complete the following steps: 1. Use a terminal emulator to connect to the UART console of the accessory device. For details, see the - [Using CLI in nRF Connect SDK examples](nrfconnect_examples_cli.md) guide. - This will grant you access to the application logs. + [Using CLI in nRF Connect examples](nrfconnect_examples_cli.md) guide. This + will grant you access to the application logs. 2. Hold **Button 1** on the accessory device for more than 6 s to trigger the factory reset of the device. 3. Find a message similar to the following one in the application logs: diff --git a/docs/guides/nrfconnect_examples_cli.md b/docs/guides/nrfconnect_examples_cli.md index 8d35aa1be12149..3b4e75e79aa8d8 100644 --- a/docs/guides/nrfconnect_examples_cli.md +++ b/docs/guides/nrfconnect_examples_cli.md @@ -1,4 +1,4 @@ -# Using CLI in nRF Connect SDK examples +# Using CLI in nRF Connect examples The following examples for the development kits from Nordic Semiconductor include a command-line interface that allows access to application logs and @@ -88,7 +88,7 @@ Done ## Using CHIP-specific commands -The nRF Connect SDK examples let you use several CHIP-specific CLI commands. +The nRF Connect examples let you use several CHIP-specific CLI commands. These commands are not available by default and to enable using them, set the `CONFIG_CHIP_LIB_SHELL=y` Kconfig option in the `prj.conf` file of the given diff --git a/docs/guides/nrfconnect_examples_configuration.md b/docs/guides/nrfconnect_examples_configuration.md index c5eb85e34ed581..b6796756d35012 100644 --- a/docs/guides/nrfconnect_examples_configuration.md +++ b/docs/guides/nrfconnect_examples_configuration.md @@ -1,7 +1,7 @@ -# Configuring nRF Connect SDK examples +# Configuring nRF Connect examples -The nRF Connect SDK example applications all come with a default configuration -for building. Check the information on this page if you want to modify the +The nRF Connect example applications all come with a default configuration for +building. Check the information on this page if you want to modify the application configuration or add new functionalities to build your own application based on the provided example. This page also contains information about the configuration structure, which can be useful to better understand the diff --git a/docs/guides/nrfconnect_examples_software_update.md b/docs/guides/nrfconnect_examples_software_update.md index 01080824f31da1..ede1c587aa7900 100644 --- a/docs/guides/nrfconnect_examples_software_update.md +++ b/docs/guides/nrfconnect_examples_software_update.md @@ -1,4 +1,4 @@ -# Performing Device Firmware Upgrade in the nRF Connect SDK examples +# Performing Device Firmware Upgrade in the nRF Connect examples The following examples for the development kits from Nordic Semiconductor support over-the-air Device Firmware Upgrade: @@ -7,7 +7,7 @@ support over-the-air Device Firmware Upgrade: - [CHIP nRF Connect Lighting Example Application](../../examples/lighting-app/nrfconnect/README.md) Currently, the Bluetooth LE is the only available transport for performing the -DFU operation and it uses +DFU operation and it uses nRF Connect SDK's [Simple Management Protocol](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/zephyr/guides/device_mgmt/index.html#device-mgmt). The upgrade can be done either using a smartphone application or a PC command line tool. @@ -26,7 +26,7 @@ following steps: 3. Push **Button 4** on the device to start the Bluetooth LE advertising. 4. Follow the instructions about downloading the new image to a device on the [FOTA upgrades](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/ug_nrf52.html#fota-upgrades) - page in the nRF Connect documentation. + page in the nRF Connect SDK documentation. ## Device Firmware Upgrade using PC command line tool diff --git a/docs/guides/openthread_border_router_pi.md b/docs/guides/openthread_border_router_pi.md index a820723def13e9..3e0ebfeea90f83 100644 --- a/docs/guides/openthread_border_router_pi.md +++ b/docs/guides/openthread_border_router_pi.md @@ -25,10 +25,11 @@ to set up your OpenThread Border Router on a Raspberry Pi 3/4 device!** > Ubuntu and debian hosts are also supported! -The CodeLab uses a Nordic nRF52840 DK as the Border Router RCP device. +The CodeLab uses Nordic Semiconductor's nRF52840 DK as the Border Router RCP +device. -- See [openthread_rcp_nrf_dongle.md](./openthread_rcp_nrf_dongle.md) for using - nRF52840 dongle as a RCP device. +- See this [guide](./openthread_rcp_nrf_dongle.md) for configuring the + nRF52840 Dongle as an RCP device. - See this [guide](https://www.silabs.com/documents/public/application-notes/an1256-using-sl-rcp-with-openthread-border-router.pdf) for creating Silicon Labs RCP devices. diff --git a/docs/guides/openthread_rcp_nrf_dongle.md b/docs/guides/openthread_rcp_nrf_dongle.md index 5cf9dc6a340177..f772529cd238cf 100644 --- a/docs/guides/openthread_rcp_nrf_dongle.md +++ b/docs/guides/openthread_rcp_nrf_dongle.md @@ -8,7 +8,7 @@ You can build and program (RCP) firmware onto Nordic Semiconductor's [nRF52840 Dongle](https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52840-Dongle). Once programmed, the dongle can be used for -[configuring Thread network on a Linux machine](linux_thread_connectivity.md). +[configuring Thread network on a Linux machine](./openthread_border_router_pi.md). ## Building and programming the RCP firmware onto an nRF52840 Dongle diff --git a/examples/shell/nrfconnect/README.md b/examples/shell/nrfconnect/README.md index fc09d34613db5c..8e17340c92069b 100644 --- a/examples/shell/nrfconnect/README.md +++ b/examples/shell/nrfconnect/README.md @@ -1,11 +1,11 @@ # CHIP nRF Connect SDK Shell Application A [chip-shell](../README.md) project for the Nordic nRF52840 and nRF5340 -development kits, built using nRF Connect SDK. +development kits, built using the nRF Connect SDK. ## Building -The steps to build the Shell Application for the Nordic development kits are -exactly the same as in case of the Lock Example. Please refer to -[this](../../lock-app/nrfconnect/README.md) guide to learn how to build, flash -and debug the application. +The steps to build the Shell Application for Nordic Semiconductor's development +kits are exactly the same as in case of the Lock Example. Please refer to +[this guide](../../lock-app/nrfconnect/README.md) to learn how to build, +program, and debug the application.