Skip to content

Commit

Permalink
doc: nrfconnect: minor style and link fixes (#7949)
Browse files Browse the repository at this point in the history
* doc: nrfconnect: minor style and link fixes

Updated style and links to and from nrfconnect guides.

Signed-off-by: Grzegorz Ferenc <[email protected]>

* Restyled by prettier-markdown

Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
2 people authored and pull[bot] committed Jul 14, 2021
1 parent 6bef8fc commit 1996756
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/guides/nrfconnect_android_commissioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/nrfconnect_examples_cli.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/nrfconnect_examples_configuration.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/nrfconnect_examples_software_update.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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.
Expand All @@ -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

Expand Down
7 changes: 4 additions & 3 deletions docs/guides/openthread_border_router_pi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/guides/openthread_rcp_nrf_dongle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions examples/shell/nrfconnect/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 1996756

Please sign in to comment.