Skip to content

Commit 6871faf

Browse files
sean-madigancarlescufi
authored andcommitted
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 <[email protected]>
1 parent 8e959a0 commit 6871faf

File tree

10 files changed

+15
-15
lines changed

10 files changed

+15
-15
lines changed

doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This setup supports both UART and Bluetooth® LE connections.
6161
The following samples are supported:
6262

6363
* :zephyr:code-sample:`smp-svr`
64-
* :ref:`zephyr:with_mcuboot`
64+
* :zephyr:code-sample:`with_mcuboot`
6565

6666
.. rst-class:: numbered-step
6767

doc/nrf/app_dev/device_guides/nrf52/features.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See :ref:`zephyr:bluetooth` for documentation on the Bluetooth Host and open sou
5151
For documentation about the SoftDevice Controller and information on which controller variants support which chips, see :ref:`nrfxlib:softdevice_controller`.
5252

5353
The |NCS| contains a variety of :ref:`ble_samples` that target nRF52 Series devices.
54-
In addition, you can run the :ref:`zephyr:bluetooth-samples` that are included from Zephyr.
54+
In addition, you can run the :zephyr:code-sample-category:`bluetooth` samples that are included from Zephyr.
5555

5656
For available libraries, see :ref:`lib_bluetooth_services` (|NCS|) and :ref:`zephyr:bluetooth_api` (Zephyr).
5757

@@ -64,7 +64,7 @@ It is optimized for creating large-scale device networks, and implemented accord
6464
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.
6565

6666
The |NCS| contains a variety of :ref:`bt_mesh_samples` that target nRF52 Series devices.
67-
In addition, you can run the :ref:`Bluetooth Mesh samples <zephyr:bluetooth-samples>` that are included from Zephyr.
67+
In addition, you can run the :zephyr:code-sample-category:`bluetooth` samples that are included from Zephyr.
6868

6969
For available libraries, see :ref:`bt_mesh` (|NCS|) and :ref:`zephyr:bluetooth_mesh` (Zephyr).
7070
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
119119

120120
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.
121121
You can find the implementation in the Zephyr repository.
122-
See :ref:`zephyr:usb_api` for documentation and :ref:`zephyr:usb-samples` for a list of available samples.
122+
See :ref:`zephyr:usb_api` for documentation and :zephyr:code-sample-category:`usb` for a list of available samples.
123123

124124
The USB stack requires the USBD driver for nRF52 devices, which is available as part of `nrfx`_.
125125
The nrfx repository is included in the |NCS| as a module of the Zephyr repository.

doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Bluetooth Low Energy
130130
- Application core
131131
* - :zephyr:code-sample:`bluetooth_hci_ipc`
132132
- | :ref:`Bluetooth Low Energy samples <ble_samples>`
133-
| :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`
133+
| :zephyr:code-sample-category:`bluetooth`
134134
* - :ref:`ble_rpc_host` (supported for development)
135135
- Some Bluetooth Low Energy samples, for example, :ref:`peripheral_hids_mouse`, :ref:`peripheral_uart` or :ref:`central_uart`
136136

@@ -151,7 +151,7 @@ The sample implements the RPMsg transport using the `OpenAMP`_ library to commun
151151
You can use either the SoftDevice Controller or the Zephyr Bluetooth LE Controller for this sample.
152152
See :ref:`ug_ble_controller` for more information.
153153

154-
For the application core, the |NCS| provides a series of :ref:`Bluetooth Low Energy samples <ble_samples>`, in addition to the :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`.
154+
For the application core, the |NCS| provides a series of :ref:`Bluetooth Low Energy samples <ble_samples>`, in addition to the :zephyr:code-sample-category:`bluetooth` samples.
155155
|multi_image|
156156

157157
.. note::
@@ -173,7 +173,7 @@ Bluetooth Mesh
173173

174174
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.
175175
For the application core, the |NCS| provides several :ref:`bt_mesh_samples`.
176-
In addition, you can find Bluetooth Mesh samples with :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`.
176+
In addition, you can find Bluetooth Mesh samples with :zephyr:code-sample-category:`bluetooth` samples.
177177

178178
IEEE 802.15.4 (Thread and Zigbee)
179179
---------------------------------

doc/nrf/app_dev/device_guides/nrf54l/features.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The :ref:`ug_ble_controller` user guide contains more information about the two
5757

5858
See the :ref:`zephyr:bluetooth` section of the Zephyr documentation for information on the Bluetooth Host and open source Bluetooth LE Controller.
5959
The |NCS| contains :ref:`ble_samples` that can be run on the nRF54L15 DK device.
60-
In addition, you can run the :ref:`zephyr:bluetooth-samples` that are included from Zephyr.
60+
In addition, you can run the :zephyr:code-sample-category:`bluetooth` samples that are included from Zephyr.
6161

6262
For available libraries, see :ref:`lib_bluetooth_services` (|NCS|) and :ref:`zephyr:bluetooth_api` (Zephyr).
6363

@@ -66,7 +66,7 @@ Bluetooth Mesh
6666

6767
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.
6868
For the application core, the |NCS| provides several :ref:`bt_mesh_samples`.
69-
In addition, you can find Bluetooth Mesh samples with :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`.
69+
In addition, you can find Bluetooth Mesh samples with :zephyr:code-sample-category:`bluetooth` samples.
7070

7171
IEEE 802.15.4
7272
=============

doc/nrf/protocols/bt/bt_solutions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Support in the |NCS|:
3535

3636
* :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.
3737

38-
* :ref:`bluetooth-samples` (Zephyr Project): The Zephyr Project offers additional Bluetooth samples.
38+
* :zephyr:code-sample-category:`bluetooth` (Zephyr Project): The Zephyr Project offers additional Bluetooth samples.
3939
These samples are not guaranteed to work as part of the |NCS|, but are helpful as starting point for a relevant use case.
4040

4141
Device networks

doc/nrf/releases_and_maturity/releases/release-notes-2.4.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The following list includes the summary of the most relevant changes introduced
5858
* Charger, BUCKs, LDOs, Load Switches, and GPIOs.
5959
* :ref:`Sample showing fuel gauge functionality <npm1300_fuel_gauge>`.
6060
The sample calculates battery state of charge, time to empty, time to full and provides updates of these over the terminal once every second.
61-
* :ref:`Sample providing a shell interface <zephyr:npm1300_ek_sample>` that supports PMIC features: regulators (BUCKs, LDO) and GPIOs.
61+
* :zephyr:code-sample:`npm1300_ek` that supports PMIC features: regulators (BUCKs, LDO) and GPIOs.
6262

6363
* Bluetooth Low Energy:
6464

doc/nrf/samples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The |NCS| provides samples that specifically target Nordic Semiconductor devices
77

88
Samples showcase a single feature or library, while :ref:`applications` include a variety of libraries to implement a specific use case.
99

10-
Zephyr also provides a variety of :ref:`zephyr:samples-and-demos`, including very simple :ref:`zephyr:basic-sample`.
10+
Zephyr also provides a variety of :zephyr:code-sample-category:`samples`, including very simple :zephyr:code-sample-category:`basic`.
1111
These samples are a good starting point for understanding how to put together your own application.
1212
However, Zephyr samples and applications are not tested and verified to work with the |NCS| releases.
1313

doc/nrf/samples/wifi_zephyr.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ The following is an example of the CLI command:
4646
4747
west build -b nrf5340dk/nrf5340/cpuapp -S wifi-ipv4 -- -DSHIELD=nrf7002ek -DSB_CONFIG_WIFI_NRF70=y
4848
49-
For additional details about running a sample, refer to the respective sample in Zephyr’s :ref:`Samples and Demos documentation <zephyr:samples-and-demos>`.
49+
For additional details about running a sample, refer to the respective sample in Zephyr’s :zephyr:code-sample-category:`samples`.

doc/nrf/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Some of them are documented in detail in other parts of this documentation, whil
4040
- See :ref:`ug_tfm`.
4141
- | - :ref:`tfm_samples`
4242
| - :ref:`crypto_samples`
43-
| - :ref:`TF-M integration samples <zephyr:tfm_integration-samples>` in Zephyr
43+
| - :zephyr:code-sample-category:`tfm_integration` in Zephyr
4444
* - Cryptographic operations (:ref:`nrf_security`)
4545
- The :ref:`nrf_security` library acts as an orchestrator for the different cryptographic libraries available in the system.
4646
HW accelerated libraries are prioritized over SW libraries when both are enabled.

doc/nrf/security/tfm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The TF-M implementation in |NCS| is demonstrated in the following samples:
2727

2828
* All :ref:`tfm_samples` in this SDK
2929
* All :ref:`cryptography samples <crypto_samples>` in this SDK
30-
* A series of :ref:`TF-M integration samples <zephyr:tfm_integration-samples>` available in Zephyr
30+
* A series of :zephyr:code-sample-category:`tfm_integration` samples available in Zephyr
3131

3232
In addition, the TF-M implementation is used in all samples and applications in this SDK that support the ``*/ns`` :ref:`variant <app_boards_names>` of the boards, due to :ref:`Cortex-M Security Extensions (CMSE) <app_boards_spe_nspe>` support.
3333

0 commit comments

Comments
 (0)