From 9c9d0564ec924ff30c4f5bbc82113896399ac315 Mon Sep 17 00:00:00 2001 From: Sean Madigan Date: Wed, 20 Nov 2024 16:07:01 +0000 Subject: [PATCH] doc: nrf: Update docs to use new zephyr code-sample-category These categories have been added upstream, so we need to update the references in our docs. Signed-off-by: Sean Madigan --- .../bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst | 2 +- doc/nrf/app_dev/device_guides/nrf52/features.rst | 6 +++--- doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst | 6 +++--- doc/nrf/app_dev/device_guides/nrf54l/features.rst | 4 ++-- doc/nrf/protocols/bt/bt_solutions.rst | 2 +- .../releases_and_maturity/releases/release-notes-2.4.0.rst | 2 +- doc/nrf/samples.rst | 2 +- doc/nrf/samples/wifi_zephyr.rst | 2 +- doc/nrf/security.rst | 2 +- doc/nrf/security/tfm.rst | 2 +- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst b/doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst index 79f8d153c4c8..165b8d22ab0e 100644 --- a/doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst +++ b/doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst @@ -61,7 +61,7 @@ This setup supports both UART and Bluetooth® LE connections. The following samples are supported: * :zephyr:code-sample:`smp-svr` -* :ref:`zephyr:with_mcuboot` +* :zephyr:code-sample:`with_mcuboot` .. rst-class:: numbered-step diff --git a/doc/nrf/app_dev/device_guides/nrf52/features.rst b/doc/nrf/app_dev/device_guides/nrf52/features.rst index eaa90ba9170a..20e6a564ca91 100644 --- a/doc/nrf/app_dev/device_guides/nrf52/features.rst +++ b/doc/nrf/app_dev/device_guides/nrf52/features.rst @@ -51,7 +51,7 @@ See :ref:`zephyr:bluetooth` for documentation on the Bluetooth Host and open sou For documentation about the SoftDevice Controller and information on which controller variants support which chips, see :ref:`nrfxlib:softdevice_controller`. The |NCS| contains a variety of :ref:`ble_samples` that target nRF52 Series devices. -In addition, you can run the :ref:`zephyr:bluetooth-samples` that are included from Zephyr. +In addition, you can run the :zephyr:code-sample-category:`bluetooth` samples that are included from Zephyr. For available libraries, see :ref:`lib_bluetooth_services` (|NCS|) and :ref:`zephyr:bluetooth_api` (Zephyr). @@ -64,7 +64,7 @@ It is optimized for creating large-scale device networks, and implemented accord Bluetooth Mesh networking allows one-to-one, one-to-many, and many-to-many communication, using the Bluetooth LE protocol to exchange messages between the mesh nodes in the network. The |NCS| contains a variety of :ref:`bt_mesh_samples` that target nRF52 Series devices. -In addition, you can run the :ref:`Bluetooth Mesh samples ` that are included from Zephyr. +In addition, you can run the :zephyr:code-sample-category:`bluetooth` samples that are included from Zephyr. For available libraries, see :ref:`bt_mesh` (|NCS|) and :ref:`zephyr:bluetooth_mesh` (Zephyr). See the :ref:`ug_bt_mesh` user guide for information about how to use the supplied libraries and work with Bluetooth Mesh. @@ -119,7 +119,7 @@ USB The |NCS| contains a USB device stack for the USB 2.0 Full Speed peripheral that is available on a number of the nRF52 devices. You can find the implementation in the Zephyr repository. -See :ref:`zephyr:usb_api` for documentation and :ref:`zephyr:usb-samples` for a list of available samples. +See :ref:`zephyr:usb_api` for documentation and :zephyr:code-sample-category:`usb` for a list of available samples. The USB stack requires the USBD driver for nRF52 devices, which is available as part of `nrfx`_. The nrfx repository is included in the |NCS| as a module of the Zephyr repository. diff --git a/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst b/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst index 8c6ac82b8159..21cb578c5fad 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst +++ b/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst @@ -130,7 +130,7 @@ Bluetooth Low Energy - Application core * - :zephyr:code-sample:`bluetooth_hci_ipc` - | :ref:`Bluetooth Low Energy samples ` - | :ref:`Bluetooth samples in Zephyr ` + | :zephyr:code-sample-category:`bluetooth` * - :ref:`ble_rpc_host` (supported for development) - Some Bluetooth Low Energy samples, for example, :ref:`peripheral_hids_mouse`, :ref:`peripheral_uart` or :ref:`central_uart` @@ -151,7 +151,7 @@ The sample implements the RPMsg transport using the `OpenAMP`_ library to commun You can use either the SoftDevice Controller or the Zephyr Bluetooth LE Controller for this sample. See :ref:`ug_ble_controller` for more information. -For the application core, the |NCS| provides a series of :ref:`Bluetooth Low Energy samples `, in addition to the :ref:`Bluetooth samples in Zephyr `. +For the application core, the |NCS| provides a series of :ref:`Bluetooth Low Energy samples `, in addition to the :zephyr:code-sample-category:`bluetooth` samples. |multi_image| .. note:: @@ -173,7 +173,7 @@ Bluetooth Mesh Bluetooth Mesh operates on Bluetooth Low Energy (LE), and is implemented according to Bluetooth Mesh Profile Specification v1.0.1 and Bluetooth Mesh Model Specification v1.0.1. For the application core, the |NCS| provides several :ref:`bt_mesh_samples`. -In addition, you can find Bluetooth Mesh samples with :ref:`Bluetooth samples in Zephyr `. +In addition, you can find Bluetooth Mesh samples with :zephyr:code-sample-category:`bluetooth` samples. IEEE 802.15.4 (Thread and Zigbee) --------------------------------- diff --git a/doc/nrf/app_dev/device_guides/nrf54l/features.rst b/doc/nrf/app_dev/device_guides/nrf54l/features.rst index afc1f0237ab5..c58ba42a40b3 100644 --- a/doc/nrf/app_dev/device_guides/nrf54l/features.rst +++ b/doc/nrf/app_dev/device_guides/nrf54l/features.rst @@ -57,7 +57,7 @@ The :ref:`ug_ble_controller` user guide contains more information about the two See the :ref:`zephyr:bluetooth` section of the Zephyr documentation for information on the Bluetooth Host and open source Bluetooth LE Controller. The |NCS| contains :ref:`ble_samples` that can be run on the nRF54L15 DK device. -In addition, you can run the :ref:`zephyr:bluetooth-samples` that are included from Zephyr. +In addition, you can run the :zephyr:code-sample-category:`bluetooth` samples that are included from Zephyr. For available libraries, see :ref:`lib_bluetooth_services` (|NCS|) and :ref:`zephyr:bluetooth_api` (Zephyr). @@ -66,7 +66,7 @@ Bluetooth Mesh Bluetooth Mesh operates on Bluetooth Low Energy (LE), and is implemented according to Bluetooth Mesh Profile Specification v1.0.1 and Bluetooth Mesh Model Specification v1.0.1. For the application core, the |NCS| provides several :ref:`bt_mesh_samples`. -In addition, you can find Bluetooth Mesh samples with :ref:`Bluetooth samples in Zephyr `. +In addition, you can find Bluetooth Mesh samples with :zephyr:code-sample-category:`bluetooth` samples. IEEE 802.15.4 ============= diff --git a/doc/nrf/protocols/bt/bt_solutions.rst b/doc/nrf/protocols/bt/bt_solutions.rst index 9279c0240a99..36b818dec2c5 100644 --- a/doc/nrf/protocols/bt/bt_solutions.rst +++ b/doc/nrf/protocols/bt/bt_solutions.rst @@ -35,7 +35,7 @@ Support in the |NCS|: * :ref:`peripheral_uart` and :ref:`central_uart`: These samples implement a Nordic-defined GATT service and profile that give a simple TX/RX generic data pipe, providing UART communication over Bluetooth LE. -* :ref:`bluetooth-samples` (Zephyr Project): The Zephyr Project offers additional Bluetooth samples. +* :zephyr:code-sample-category:`bluetooth` (Zephyr Project): The Zephyr Project offers additional Bluetooth samples. These samples are not guaranteed to work as part of the |NCS|, but are helpful as starting point for a relevant use case. Device networks diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst index 6f5724bd6647..eb5bd677ee93 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst @@ -58,7 +58,7 @@ The following list includes the summary of the most relevant changes introduced * Charger, BUCKs, LDOs, Load Switches, and GPIOs. * :ref:`Sample showing fuel gauge functionality `. The sample calculates battery state of charge, time to empty, time to full and provides updates of these over the terminal once every second. - * :ref:`Sample providing a shell interface ` that supports PMIC features: regulators (BUCKs, LDO) and GPIOs. + * :zephyr:code-sample:`npm1300_ek` that supports PMIC features: regulators (BUCKs, LDO) and GPIOs. * Bluetooth Low Energy: diff --git a/doc/nrf/samples.rst b/doc/nrf/samples.rst index 68ded04f553c..b12487559441 100644 --- a/doc/nrf/samples.rst +++ b/doc/nrf/samples.rst @@ -7,7 +7,7 @@ The |NCS| provides samples that specifically target Nordic Semiconductor devices Samples showcase a single feature or library, while :ref:`applications` include a variety of libraries to implement a specific use case. -Zephyr also provides a variety of :ref:`zephyr:samples-and-demos`, including very simple :ref:`zephyr:basic-sample`. +Zephyr also provides a variety of :zephyr:code-sample-category:`samples`, including very simple :zephyr:code-sample-category:`basic`. These samples are a good starting point for understanding how to put together your own application. However, Zephyr samples and applications are not tested and verified to work with the |NCS| releases. diff --git a/doc/nrf/samples/wifi_zephyr.rst b/doc/nrf/samples/wifi_zephyr.rst index e994b665cbe1..bd21d7cb21bd 100644 --- a/doc/nrf/samples/wifi_zephyr.rst +++ b/doc/nrf/samples/wifi_zephyr.rst @@ -46,4 +46,4 @@ The following is an example of the CLI command: west build -b nrf5340dk/nrf5340/cpuapp -S wifi-ipv4 -- -DSHIELD=nrf7002ek -DSB_CONFIG_WIFI_NRF70=y -For additional details about running a sample, refer to the respective sample in Zephyr’s :ref:`Samples and Demos documentation `. +For additional details about running a sample, refer to the respective sample in Zephyr’s :zephyr:code-sample-category:`samples`. diff --git a/doc/nrf/security.rst b/doc/nrf/security.rst index 931d8eb5638a..4837f839eaa1 100644 --- a/doc/nrf/security.rst +++ b/doc/nrf/security.rst @@ -40,7 +40,7 @@ Some of them are documented in detail in other parts of this documentation, whil - See :ref:`ug_tfm`. - | - :ref:`tfm_samples` | - :ref:`crypto_samples` - | - :ref:`TF-M integration samples ` in Zephyr + | - :zephyr:code-sample-category:`tfm_integration` in Zephyr * - Cryptographic operations (:ref:`nrf_security`) - The :ref:`nrf_security` library acts as an orchestrator for the different cryptographic libraries available in the system. HW accelerated libraries are prioritized over SW libraries when both are enabled. diff --git a/doc/nrf/security/tfm.rst b/doc/nrf/security/tfm.rst index 69b29519b9e6..48d3f3b30722 100644 --- a/doc/nrf/security/tfm.rst +++ b/doc/nrf/security/tfm.rst @@ -27,7 +27,7 @@ The TF-M implementation in |NCS| is demonstrated in the following samples: * All :ref:`tfm_samples` in this SDK * All :ref:`cryptography samples ` in this SDK -* A series of :ref:`TF-M integration samples ` available in Zephyr +* A series of :zephyr:code-sample-category:`tfm_integration` samples available in Zephyr In addition, the TF-M implementation is used in all samples and applications in this SDK that support the ``*/ns`` :ref:`variant ` of the boards, due to :ref:`Cortex-M Security Extensions (CMSE) ` support.