Skip to content

Commit

Permalink
doc: nrf: Update docs to use new zephyr code-sample-category
Browse files Browse the repository at this point in the history
These categories have been added upstream, so we need to
update the references in our docs.

Signed-off-by: Sean Madigan <[email protected]>
  • Loading branch information
sean-madigan committed Nov 20, 2024
1 parent 9c13565 commit b9d922c
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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-category:`with_mcuboot`

.. rst-class:: numbered-step

Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/app_dev/device_guides/nrf52/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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 <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:`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.
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Bluetooth Low Energy
- Application core
* - :zephyr:code-sample:`bluetooth_hci_ipc`
- | :ref:`Bluetooth Low Energy samples <ble_samples>`
| :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`
| :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`

Expand All @@ -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 <ble_samples>`, in addition to the :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`.
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.
|multi_image|

.. note::
Expand All @@ -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 <zephyr:bluetooth-samples>`.
In addition, you can find Bluetooth Mesh samples with :zephyr:code-sample-category:`bluetooth` samples.

IEEE 802.15.4 (Thread and Zigbee)
---------------------------------
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/app_dev/device_guides/nrf54l/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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 <zephyr:bluetooth-samples>`.
In addition, you can find Bluetooth Mesh samples with :zephyr:code-sample-category:`bluetooth` samples.

IEEE 802.15.4
=============
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/protocols/bt/bt_solutions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <npm1300_fuel_gauge>`.
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 <zephyr:npm1300_ek_sample>` that supports PMIC features: regulators (BUCKs, LDO) and GPIOs.
* :zephyr:code-sample-category:`npm1300_ek_sample` that supports PMIC features: regulators (BUCKs, LDO) and GPIOs.

* Bluetooth Low Energy:

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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-sample`.
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.

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/samples/wifi_zephyr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <zephyr:samples-and-demos>`.
For additional details about running a sample, refer to the respective sample in Zephyr’s :zephyr:code-sample-category:`samples`.
2 changes: 1 addition & 1 deletion doc/nrf/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <zephyr:tfm_integration-samples>` in Zephyr
| - :zephyr:code-sample-category:`tfm_integration-samples` 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.
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/security/tfm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <crypto_samples>` in this SDK
* A series of :ref:`TF-M integration samples <zephyr:tfm_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 <app_boards_names>` of the boards, due to :ref:`Cortex-M Security Extensions (CMSE) <app_boards_spe_nspe>` support.

Expand Down

0 comments on commit b9d922c

Please sign in to comment.