Skip to content

Commit 6d0cd8d

Browse files
umapraseedarlubos
authored andcommitted
doc: Doc fixes for 2.8
Doc fixes for 2.8 - release task Signed-off-by: Uma Praseeda <[email protected]> (cherry picked from commit a6fe428)
1 parent 2226307 commit 6d0cd8d

File tree

62 files changed

+286
-274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+286
-274
lines changed

applications/machine_learning/app_desc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@ Forwarding data.
659659

660660
a. Open the `nRF Connect for Mobile`_ application and connect to the device again.
661661
#. Bond with the device from the `nRF Connect for Mobile`_ application on your smartphone or tablet.
662-
#. Find **Nordic UART Service** and enable notification of its "TX Charcteristic".
662+
#. Find **Nordic UART Service** and enable notification of its "TX Characteristic".
663663
#. Observe the sensor readouts represented as comma-separated values.
664664
Every new value represents a single sensor readout.
665665

applications/matter_weather_station/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ To build this application to work with the nRF7002 Wi-Fi expansion board:
223223
Generating factory data
224224
=======================
225225

226-
To enable factory data support, you need to select the ``overlay-factory_data`` configuration overlay from the available application :ref:`build configuration overlays <matter_weather_station_app_build_configuration_overlays>`, set the ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE`` kconfig option to ``y``, and use the ``factory_data`` file suffix.
226+
To enable factory data support, you need to select the ``overlay-factory_data`` configuration overlay from the available application :ref:`build configuration overlays <matter_weather_station_app_build_configuration_overlays>`, set the ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE`` Kconfig option to ``y``, and use the ``factory_data`` file suffix.
227227
You can generate new factory data set when building for the given board target by invoking the following command:
228228

229229
.. code-block:: console

applications/nrf_desktop/bluetooth.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The information about peer and connection state is propagated to other applicati
1414

1515
The :ref:`CONFIG_DESKTOP_BT <config_desktop_app_options>` Kconfig option enables support for Bluetooth connectivity in the nRF Desktop.
1616
Specific Bluetooth configurations and application modules are selected or implied according to the HID device role.
17-
Apart from that, the defaults of Bluetooth-related Kconfigs are aligned with the nRF Desktop use case.
17+
Apart from that, the defaults of Bluetooth-related Kconfig options are aligned with the nRF Desktop use case.
1818

1919
The nRF Desktop devices come in the following roles:
2020

applications/serial_lte_modem/doc/CARRIER_AT_commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ The ``<cmd>`` command is a string, and can be used as follows:
174174

175175
* ``AT#XCARRIER="app_data_create",<obj_inst_id>,<res_inst_id>``
176176

177-
Create an empty resource instance of the Data resource (ID: 0) of the Binary App Data Containet object (ID: 19).
177+
Create an empty resource instance of the Data resource (ID: 0) of the Binary App Data Container object (ID: 19).
178178

179179
``<obj_inst_id>`` indicates the target object instance.
180180

applications/serial_lte_modem/doc/SOCKET_AT_commands.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1284,6 +1284,7 @@ Syntax
12841284

12851285
* The ``<hostname>`` parameter is a string.
12861286
* The ``<address_family>`` parameter is an integer that gives a hint for DNS query on address family.
1287+
12871288
* ``0`` means unspecified address family.
12881289
* ``1`` means IPv4 address family.
12891290
* ``2`` means IPv6 address family.

applications/serial_lte_modem/doc/TCPUDP_AT_commands.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -716,11 +716,10 @@ UDP receive data
716716

717717
::
718718

719-
#XUDPDATA notification comes only when SLM is not operating in :ref:`data mode <slm_data_mode>`.
720-
721719
#XUDPDATA: <size>,<ip_addr>,<port>
722720
<data>
723721

722+
* ``#XUDPDATA`` notification comes only when SLM is not operating in :ref:`data mode <slm_data_mode>`.
724723
* The ``<size>`` value is an integer that represents the actual number of bytes received.
725724
* The ``<ip_addr>`` value is a string that represents the IPv4 or IPv6 address of the remote peer.
726725
* The ``<port>`` value is an integer that represents the UDP port of the remote peer.

applications/serial_lte_modem/doc/nRF91_as_Zephyr_modem.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Overview
1111
********
1212

1313
Starting with |NCS| v2.6.0, the Serial LTE Modem (SLM) application can be used to turn an nRF91 Series SiP into a standalone modem that can be used through Zephyr's cellular modem driver.
14-
This means that the controlling chip can run a Zephyr application that seamlessly uses Zephyr's IP stack instead of offloaded sockets via AT commands.
14+
This means that the controlling chip can run a Zephyr application that seamlessly uses Zephyr's IP stack instead of offloaded sockets through AT commands.
1515

1616
This is made possible by SLM's support of CMUX and PPP and Zephyr's cellular modem driver.
1717

@@ -121,7 +121,7 @@ If SLM is running on the nRF9160 DK, the **PROG/DEBUG SW10** switch needs to be
121121
However, for convenience you may want to redirect SLM's logs to the SiP's UART 0 so that you do not need to reconnect the RTT client every time the board is reset.
122122
See the :ref:`slm_additional_config` section for information on how to do this.
123123

124-
The logs output via UART can be seen by connecting to the appropriate UART with a serial communication program.
124+
The logs output through UART can be seen by connecting to the appropriate UART with a serial communication program.
125125
Under Linux, if the controlling chip is the nRF52840 of the nRF9160 DK, the device file of its UART 0 will typically be :file:`/dev/ttyACM1`.
126126

127127
After both applications have been flashed to their respective chips and you are connected to receive logs, you can reset the controlling chip.

doc/nrf/app_dev/bootloaders_dfu/dfu_tools_mcumgr_cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Adding names requires an additional step:
396396
STATS_NAME(my_stats, my_stat_counter3)
397397
STATS_NAME_END(my_stats);
398398
399-
The :kconfig:option:`CONFIG_MCUMGR_GRP_STAT_MAX_NAME_LEN` Kconfig option sets the maximum length of a section name that can can be accepted as parameter for showing the section data.
399+
The :kconfig:option:`CONFIG_MCUMGR_GRP_STAT_MAX_NAME_LEN` Kconfig option sets the maximum length of a section name that can be accepted as parameter for showing the section data.
400400
This may need adjustment for particularly long section names.
401401

402402
.. note::
@@ -479,7 +479,7 @@ To upload a new file to a littleFS storage, mounted under ``/lfs``, use the foll
479479
where ``25`` is the size of the file.
480480

481481
To download a file, first you must use the ``fs`` command with the :kconfig:option:`CONFIG_FILE_SYSTEM_SHELL` Kconfig option enabled.
482-
This allows operations via remote shell.
482+
This allows operations using remote shell.
483483
Create a new file on the remote system:
484484

485485
.. code-block:: console

doc/nrf/app_dev/bootloaders_dfu/qspi_xip_split_image.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Configure :ref:`configuration_system_overview_sysbuild` to enable the required K
152152

153153
.. tabs::
154154

155-
.. group-tab:: With networe core support
155+
.. group-tab:: With network core support
156156

157157
.. code-block:: cmake
158158
@@ -220,7 +220,7 @@ The standard procedure will program the firmware using the default nrfjprog conf
220220
Programming using a different SPI mode
221221
======================================
222222

223-
If you are using an a different SPI mode on the QSPI interface, such as DSPI, you must use a custom :file:`Qspi.ini` file.
223+
If you are using a different SPI mode on the QSPI interface, such as DSPI, you must use a custom :file:`Qspi.ini` file.
224224
The following is an example for the Thingy:53, which supports DSPI and PP:
225225

226226
.. literalinclude:: ../../../../samples/nrf5340/extxip_smp_svr/Qspi_thingy53.ini

doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ sysbuild.cmake:
190190
191191
.. _sysbuild_images_adding_via_a_zephyr_module:
192192

193-
Adding via a zephyr module
194-
--------------------------
193+
Adding through a Zephyr module
194+
------------------------------
195195

196196
To add images in a Zephyr module, create a folder within the module to hold the `Kconfig.sysbuild` and (optionally, if needed) `CMakeLists.txt` files.
197197
Then, add this folder to the Zephyr module file:

0 commit comments

Comments
 (0)