Skip to content

Commit

Permalink
doc: fix broken links, minor fixes, and toc update
Browse files Browse the repository at this point in the history
* Fixed broken links and toc update.
* Fixed a minor update to
the nRF desktop application.
* Arranged Applications in
alphabetical order.
* Update with respect to nRF9151.

Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
  • Loading branch information
divipillai authored and jfischer-no committed Mar 5, 2024
1 parent 9fcb14b commit d1a0e3d
Show file tree
Hide file tree
Showing 25 changed files with 52 additions and 50 deletions.
4 changes: 2 additions & 2 deletions applications/nrf_desktop/application_kconfig.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _nrf_desktop_application_Kconfig:

nRF Desktop application-specific Kconfig options
################################################
nRF Desktop: Application-specific Kconfig options
#################################################

.. contents::
:local:
Expand Down
4 changes: 2 additions & 2 deletions applications/nrf_desktop/configuration_options.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _config_desktop_app_options:

nRF Desktop application Kconfig options scheme
##############################################
nRF Desktop: Application Kconfig options scheme
###############################################

.. contents::
:local:
Expand Down
6 changes: 2 additions & 4 deletions applications/nrf_desktop/description.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _nrf_desktop_description:

nRF Desktop application description
###################################
nRF Desktop: Application description
####################################

.. contents::
:local:
Expand Down Expand Up @@ -881,8 +881,6 @@ You can also configure the following feature in the nRF Desktop application:
* :ref:`Memory layout <nrf_desktop_memory_layout>`
* :ref:`Bluetooth <nrf_desktop_bluetooth_guide>`
* :ref:`Bootloader and Device Firmware Update <nrf_desktop_bootloader>`
* :ref:`nrf_desktop_board_configuration`
* :ref:`nrf_desktop_nrf21540ek`

Building and running
********************
Expand Down
4 changes: 2 additions & 2 deletions applications/nrf_desktop/integration.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _nrf_desktop_porting_guide:

Integrating your own hardware into the nRF Desktop application
##############################################################
nRF Desktop: Integrating your own hardware
##########################################

.. contents::
:local:
Expand Down
4 changes: 2 additions & 2 deletions applications/nrf_desktop/modules.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _nrf_desktop_app_internal_modules:

nRF Desktop application internal modules
########################################
nRF Desktop: Application internal modules
#########################################

.. contents::
:local:
Expand Down
2 changes: 1 addition & 1 deletion applications/serial_lte_modem/doc/HTTPC_AT_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Syntax
* ``0`` - Do not verify the hostname against the received certificate.
* ``1`` - Verify the hostname against the received certificate (default).

See `nRF socket options`_ ``peer_verify`` and ``tls_hostname`` for more information on ``<peer_verify>`` and ``<hostname_verify>``.
See :ref:`nRF socket options <nrfxlib:nrf_sockets>` ``peer_verify`` and ``tls_hostname`` for more information on ``<peer_verify>`` and ``<hostname_verify>``.


Response syntax
Expand Down
4 changes: 2 additions & 2 deletions applications/serial_lte_modem/doc/SOCKET_AT_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ Syntax
This lets the modem stay in connected mode longer.


See `nRF socket options`_ for explanation of the supported options.
See :ref:`nRF socket options <nrfxlib:nrf_sockets>` for explanation of the supported options.

Examples
~~~~~~~~
Expand Down Expand Up @@ -694,7 +694,7 @@ Syntax
* ``<value>`` is an integer that indicates the DTLS handshake timeout in seconds.
It can be one of the following values: ``1``, ``3``, ``7``, ``15``, ``31``, ``63``, ``123``.

See `nRF socket options`_ for explanation of the supported options.
See :ref:`nRF socket options <nrfxlib:nrf_sockets>` for explanation of the supported options.


Example
Expand Down
4 changes: 2 additions & 2 deletions applications/serial_lte_modem/doc/TCPUDP_AT_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ Syntax
* ``0`` - Do not verify the hostname against the received certificate.
* ``1`` - Verify the hostname against the received certificate (default).

See `nRF socket options`_ ``peer_verify`` and ``tls_hostname`` for more information on ``<peer_verify>`` and ``<hostname_verify>``.
See :ref:`nRF socket options <nrfxlib:nrf_sockets>` ``peer_verify`` and ``tls_hostname`` for more information on ``<peer_verify>`` and ``<hostname_verify>``.

Response syntax
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -583,7 +583,7 @@ Syntax
* ``0`` - Do not verify the hostname against the received certificate.
* ``1`` - Verify the hostname against the received certificate (default).

See `nRF socket options`_ ``peer_verify`` and ``tls_hostname`` for more information on ``<peer_verify>`` and ``<hostname_verify>``.
See :ref:`nRF socket options <nrfxlib:nrf_sockets>` ``peer_verify`` and ``tls_hostname`` for more information on ``<peer_verify>`` and ``<hostname_verify>``.

Response syntax
~~~~~~~~~~~~~~~
Expand Down
3 changes: 3 additions & 0 deletions doc/matter/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,14 @@
(MATTER_BASE / "docs" / "guides", "nrfconnect_examples_configuration.md"),
(MATTER_BASE / "docs" / "guides", "nrfconnect_examples_cli.md"),
(MATTER_BASE / "docs" / "guides", "nrfconnect_examples_software_update.md"),
(MATTER_BASE / "docs" / "guides", "openthread_border_router_pi.md"),
(MATTER_BASE / "docs" / "guides", "openthread_rcp_nrf_dongle.md"),
(MATTER_BASE / "docs" / "guides", "nrfconnect_factory_data_configuration.md"),
(MATTER_BASE / "docs" / "guides", "BUILDING.md"),
(MATTER_BASE / "docs" / "guides", "chip_tool_guide.md"),
(MATTER_BASE / "docs" / "guides", "access-control-guide.md"),
(MATTER_BASE / "src" / "tools" / "chip-cert", "README.md"),

]


Expand Down
2 changes: 2 additions & 0 deletions doc/matter/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ This documentation set includes a selection of pages available in the `Matter <h
chip_tool_guide
access-control-guide
README
openthread_border_router_pi
openthread_rcp_nrf_dongle.md

.. toctree::
:maxdepth: 1
Expand Down
8 changes: 4 additions & 4 deletions doc/nrf/applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ If you want to list applications available for one or more specific boards, `use
:glob:
:caption: Subpages:

../../applications/asset_tracker_v2/README
../../applications/connectivity_bridge/README
../../applications/ipc_radio/README
../../applications/matter_bridge/README
../../applications/asset_tracker_v2/README
../../applications/serial_lte_modem/README
../../applications/nrf_desktop/README
../../applications/nrf5340_audio/index
../../applications/nrf_desktop/README
../../applications/machine_learning/README
../../applications/serial_lte_modem/README
../../applications/matter_weather_station/README
../../applications/zigbee_weather_station/README
../../applications/ipc_radio/README
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To enable external flash with MCUboot, complete the following steps:
#. Enable the :kconfig:option:`CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY` Kconfig option.
(Depending on the build configuration, this option will be set to ``y`` automatically.)

#. Update the ``CONFIG_BOOT_MAX_IMG_SECTORS`` `MCUboot Kconfig option <https://github.com/nrfconnect/sdk-mcuboot/blob/main/boot/zephyr/Kconfig#L370>`_ accordingly for child images.
#. Update the ``CONFIG_BOOT_MAX_IMG_SECTORS`` `MCUboot Kconfig option`_ accordingly for child images.
This option defines the maximum number of image sectors MCUboot can handle, as MCUboot typically increases slot sizes when external flash is enabled.
Otherwise the ``CONFIG_BOOT_MAX_IMG_SECTORS`` Kconfig option defaults to the value used for internal flash, and the application may not boot if the value is set too low.

Expand Down
3 changes: 1 addition & 2 deletions doc/nrf/libraries/modem/modem_antenna.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ Configuration
Set the :kconfig:option:`CONFIG_MODEM_ANTENNA` Kconfig option to enable this library.

.. note::

The library is enabled by default when building for targets ``nrf9161dk_nrf9161_ns``, ``nrf9160dk_nrf9160_ns``, and ``thingy91_nrf9160_ns``.
The library is enabled by default when building for the nRF91 Series build targets.

Use one of the following options to select the used antenna type:

Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/libraries/networking/aws_fota.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,10 @@ Known error codes
=================

ERROR: ``-NRF_ECONNREFUSED``:
Error ``-NRF_ECONNREFUSED`` ("Connection refused") indicates an error with the configured certificates.
Connection refused - This indicates an error with the configured certificates.

ERROR: ``-NRF_EHOSTUNREACH``:
Error ``-NRF_EHOSTUNREACH`` ("Host is unreachable") indicates that the download URL provided in the job document is wrong.
Host is unreachable - This indicates that the download URL provided in the job document is wrong.

Content range is not defined:
If you host the firmware image on a different server than in an S3 bucket, this error indicates that the Content-Range field is missing in the HTTP GET header.
Expand Down
17 changes: 8 additions & 9 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@

.. _`sdk-mcuboot`: https://github.com/nrfconnect/sdk-mcuboot
.. _`MCUboot repository`: https://github.com/mcu-tools/mcuboot
.. _`MCUboot Kconfig option`: https://github.com/nrfconnect/sdk-mcuboot/blob/main/boot/zephyr/Kconfig#L370

.. _`sdk-mbedtls`: https://github.com/nrfconnect/sdk-mbedtls
.. _`Arm Mbed TLS project`: https://github.com/ARMmbed/mbedtls
Expand Down Expand Up @@ -139,8 +140,8 @@
.. _`LogModule enumeration`: https://github.com/nrfconnect/sdk-connectedhomeip/blob/181b0cb/src/lib/support/logging/Constants.h
.. _`Matter SDK's Logging header`: https://github.com/nrfconnect/sdk-connectedhomeip/blob/181b0cb/src/lib/support/logging/CHIPLogging.h

.. _`bt_nus_service.cpp`: https://github.com/nrfconnect/sdk-nrf/blob/main/samples/matter/common/src/bt_nus_service.cpp
.. _`bt_nus_service.h`: https://github.com/nrfconnect/sdk-nrf/blob/main/samples/matter/common/src/bt_nus_service.h
.. _`bt_nus_service.cpp`: https://github.com/nrfconnect/sdk-nrf/blob/main/samples/matter/common/src/bt_nus/bt_nus_service.cpp
.. _`bt_nus_service.h`: https://github.com/nrfconnect/sdk-nrf/blob/main/samples/matter/common/src/bt_nus/bt_nus_service.h

.. _`DCL Quick Start Guide`: https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/docs/quickStartGuide.adoc

Expand All @@ -161,10 +162,6 @@

.. _`fwupd`: https://github.com/fwupd/fwupd

.. _`PR #329 in sdk-homekit repo`: https://github.com/nrfconnect/sdk-homekit/pull/329

.. _`PR #332 in sdk-homekit repo`: https://github.com/nrfconnect/sdk-homekit/pull/332

.. _`docbuild`: https://github.com/nrfconnect/sdk-nrf/blob/main/.github/workflows/docbuild.yml
.. _`docpublish`: https://github.com/nrfconnect/sdk-nrf/blob/main/.github/workflows/docpublish.yml

Expand Down Expand Up @@ -334,7 +331,7 @@

.. _`Repositories and revisions for v2.5.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.2/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.5.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.1/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.5.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.0/nrf/introduction.html#ncs-repository-revisions
.. _`Repositories and revisions for v2.5.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.5.0/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.4.3`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.3/nrf/introduction.html#ncs-repository-revisions
.. _`Repositories and revisions for v2.4.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.2/nrf/introduction.html#ncs-repository-revisions
.. _`Repositories and revisions for v2.4.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.4.1/nrf/introduction.html#ncs-repository-revisions
Expand Down Expand Up @@ -410,6 +407,8 @@

.. _`Capabilities for the LE Audio Controller Subsystem for nRF5340`: https://developer.nordicsemi.com/nRF_Connect_SDK/nrf5340_audio/bt_ll_acs_nrf53/bt_ll_acs_nrf53_capabilities.pdf

.. _`nRF9160: GPS with SUPL client library`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.2.0/nrf/samples/nrf9160/gps/README.html

.. ### Source: www.nordicsemi.com

.. _`Nordic Semiconductor website`: https://www.nordicsemi.com/
Expand Down Expand Up @@ -1258,7 +1257,7 @@
.. _`nRF Cloud integration with Coiote Device Management`: https://iotdevzone.avsystem.com/docs/Cloud_integrations/nRF_Cloud_Location_services/Configure_nRF_Cloud_integration/
.. _`Viewing device location in Coiote Device Management`: https://iotdevzone.avsystem.com/docs/Cloud_integrations/nRF_Cloud_Location_services/Configure_nRF_Cloud_integration/#view-device-location-in-coiote-dm
.. _`Setting observations for an object`: https://iotdevzone.avsystem.com/docs/Coiote_IoT_DM/Quick_Start/Visualize_device_data/#set-observation-and-add-widget
.. _`nRF9160 Anjay integration`: https://iotdevzone.avsystem.com/docs/LwM2M_Client/Nordic/nRF9160/
.. _`nRF9160 Anjay integration`: https://iotdevzone.avsystem.com/docs/LwM2M_Client/Nordic/nRF9160DK/
.. _`Thingy:91 integration`: https://iotdevzone.avsystem.com/docs/LwM2M_Client/Nordic/Thingy91/#thingy91

.. ### Source: mosquitto
Expand Down Expand Up @@ -1410,7 +1409,7 @@

.. _`Termite`: https://www.compuphase.com/software_termite.htm

.. _`Teraterm`: https://ttssh2.osdn.jp/index.html.en
.. _`Teraterm`: https://teratermproject.github.io/index-en.html

.. _`GNU Project Debugger`: https://www.sourceware.org/gdb/

Expand Down
6 changes: 5 additions & 1 deletion doc/nrf/protocols/thread/sed_ssed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Sleepy End Device types in Thread
#################################

.. contents::
:local:
:depth: 2

Sleepy End Devices (SEDs) and Synchronized Sleepy End Devices (SSEDs) are both Minimal Thread Devices (MTDs).
Unlike Full Thread Devices (FTDs), MTDs do not maintain a routing table and are typically low-power devices that are not always on.

Expand All @@ -20,7 +24,7 @@ The :kconfig:option:`CONFIG_OPENTHREAD_POLL_PERIOD` Kconfig handles the SED conf
A higher polling frequency results in lower latency (better responsiveness), but also higher power consumption.

The polling period can also be configured in runtime.
See the ``pollperiod`` command in the OpenThread `CLI reference <OpenThread CLI Reference - pollperiod command>`_.
See the ``pollperiod`` command in the OpenThread `CLI reference <OpenThread CLI Reference - pollperiod command_>`_.

Synchronized Sleepy End Device
******************************
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2115,7 +2115,7 @@ NCSDK-5666: LTE Sensor Gateway
.. rst-class:: v1-2-0

GPS sockets and SUPL client library stops working
The `nRF9160: GPS with SUPL client library <https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.2.0/nrf/samples/cellular/gps/README.html>`_ sample stops working if :ref:`supl_client` support is enabled, but the SUPL host name cannot be resolved.
The `nRF9160: GPS with SUPL client library`_ sample stops working if :ref:`supl_client` support is enabled, but the SUPL host name cannot be resolved.

**Affected platforms:** nRF9160

Expand Down Expand Up @@ -4333,7 +4333,7 @@ KRKNWK-13063: RTT logs do not work with the Light Bulb multiprotocol sample with
KRKNWK-13064: Nordic DFU is not compliant with HAP certification requirements
Some of the HAP certification requirements are not met by the Nordic DFU solution.

**Workaround:** Cherry-pick changes from `PR #332 in sdk-homekit repo`_.
**Workaround:** Cherry-pick changes from PR #332 in the sdk-homekit repository.

.. rst-class:: v1-9-2 v1-9-1 v1-9-0 v1-8-0 v1-7-1 v1-7-0

Expand All @@ -4351,7 +4351,7 @@ KRKNWK-13095: Change in KVS key naming scheme causes an error for updated device
A previous implementation allowed for empty key in domain.
This has been restricted during refactoring.

**Workaround:** Cherry-pick changes from `PR #329 in sdk-homekit repo`_.
**Workaround:** Cherry-pick changes from PR #329 in the sdk-homekit repository.

.. rst-class:: v1-9-2 v1-9-1 v1-9-0

Expand Down
1 change: 0 additions & 1 deletion doc/nrf/samples/nfc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
NFC samples
###########


.. toctree::
:maxdepth: 1
:caption: Subpages
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/shortcuts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -202,4 +202,4 @@
.. |hex_format| replace:: The certificate is automatically converted to a HEX format in the :file:`CMakeLists.txt` file.
The generated :file:`.inc` file is then included in the code, where it is provisioned to the modem.

.. |build_target| replace:: Replace the *build_target* with the build target of the DK you are using (see the Requirements section).
.. |build_target| replace:: Replace the *build_target* with the build target of the nRF91 Series device you are using (see the Requirements section).
2 changes: 1 addition & 1 deletion samples/cellular/modem_shell/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1242,7 +1242,7 @@ For example:
.. parsed-literal::
:class: highlight
west build -p -b *build_target* -d build -- -DOVERLAY_CONFIG="overlay-cloud_mqtt.conf" -DCONFIG_LOCATION_SERVICE_EXTERNAL=y
west build -p -b *build_target* -d build -- -DOVERLAY_CONFIG=overlay-cloud_mqtt.conf -DCONFIG_LOCATION_SERVICE_EXTERNAL=y
|build_target|

Expand Down
4 changes: 2 additions & 2 deletions samples/cellular/nrf_cloud_multi_service/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ The `nRF Cloud Provisioning Service`_ allows you to securely provision and onboa

.. note::

This service is not compatible with devices that use the nRF9160, but only newer nRF91x1 devices such as the nRF9151 and nRF9161.
This service is not compatible with devices that use the nRF9160, but only for the nRF9161 device.

You can enable support for this service by building the sample as follows:

Expand Down Expand Up @@ -974,7 +974,7 @@ Download and install nRF Cloud Utilities
To perform many of the actions in the other sections, you will need to install the `nRF Cloud Utilities <nRF Cloud Utilities documentation_>`_ repository.
This is not necessary if you are using the `auto-onboarding <nRF Cloud Auto-onboarding_>`_ feature of the nRF Cloud Provisioning Service.

To install the repository, clone or download it and `install the required packages <nRF Cloud Utilities Prerequisites>`_.
To install the repository, clone or download it and `install the required packages <nRF Cloud Utilities Prerequisites_>`_.

.. _nrf_cloud_multi_service_provisioning_service:

Expand Down
4 changes: 1 addition & 3 deletions samples/cellular/nrf_provisioning/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Requirements

The sample supports the following development kits:

.. table-from-rows:: /includes/sample_board_rows.txt
:header: heading
:rows: nrf9161dk_nrf9161_ns
.. table-from-sample-yaml::

.. include:: /includes/tfm.txt

Expand Down
2 changes: 1 addition & 1 deletion samples/edge_impulse/data_forwarder/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Edge Impulse: Data forwarder
:local:
:depth: 2

The Edge Impulse data forwarder sample demonstrates the usage of `Edge Impulse's data forwarder`_ to provide sensor data to `Edge Impulse studio`_ when :ref:`ug_edge_impulse`.
The Edge Impulse data forwarder sample demonstrates the usage of `Edge Impulse's data forwarder`_ to provide sensor data to `Edge Impulse studio`_ when :ref:`integrating Edge Impulse with the |NCS| <ug_edge_impulse>`.
The sample forwards simulated accelerometer data generated by the :ref:`sensor_sim`.

Requirements
Expand Down
2 changes: 1 addition & 1 deletion samples/edge_impulse/wrapper/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Edge Impulse: Wrapper
:depth: 2

The Edge Impulse wrapper sample demonstrates the functionality of the :ref:`ei_wrapper`.
It shows how to use the wrapper to run a custom `Edge Impulse`_ machine learning model when :ref:`ug_edge_impulse`.
It shows how to use the wrapper to run a custom `Edge Impulse`_ machine learning model when :ref:`integrating Edge Impulse with the |NCS| <ug_edge_impulse>`.

Requirements
************
Expand Down
2 changes: 1 addition & 1 deletion west.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ manifest:
- name: nrfxlib
repo-path: sdk-nrfxlib
path: nrfxlib
revision: 5ad13eea8adfc4f3dc3b458efef32ca54c59dddb
revision: a0ae523858766ee2e615a636f72484416efcf685
- name: trusted-firmware-m
repo-path: sdk-trusted-firmware-m
path: modules/tee/tf-m/trusted-firmware-m
Expand Down

0 comments on commit d1a0e3d

Please sign in to comment.