doc: samples: add descriptions to sample sections

greg-fer · rlubos · commit 36f20ac63b3b · 2024-10-22T13:52:33.000+02:00
Added generic description to each sample section.
The description includes links to the related documentation,
general information about the SDK samples, and information
about filtering boards in the VSC extension.
NCSDK-23685.

Signed-off-by: Grzegorz Ferenc &lt;Grzegorz.Ferenc@nordicsemi.no&gt;
diff --git a/doc/nrf/samples.rst b/doc/nrf/samples.rst
@@ -11,6 +11,8 @@ Zephyr also provides a variety of :ref:`zephyr:samples-and-demos`, including ver
 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.
 
+.. samples_general_info_start
+
 General information about samples in the |NCS|
    * |ncs_unchanged_samples_note|
    * |ncs_oot_sample_note|
@@ -19,10 +21,12 @@ General information about samples in the |NCS|
      You can change the default behavior by updating the configuration option :kconfig:option:`CONFIG_RESET_ON_FATAL_ERROR`.
    * All samples in the |NCS| are tested and verified in accordance with their :ref:`maturity level <software_maturity>`.
 
+.. samples_general_info_end
+
 .. note::
    |common_sample_components_desc|
 
-If you want to list samples available for one or more specific boards, `use the nRF Connect for Visual Studio Code extension to filter them <Browse samples_>`_.
+|filter_samples_by_board|
 
 .. toctree::
    :maxdepth: 1
diff --git a/doc/nrf/samples/bl.rst b/doc/nrf/samples/bl.rst
@@ -3,6 +3,14 @@
 Bluetooth samples
 #################
 
+This section lists the available |NCS| samples for the :ref:`ug_bt` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/cellular.rst b/doc/nrf/samples/cellular.rst
@@ -3,6 +3,15 @@
 Cellular samples
 ################
 
+This section lists the available |NCS| samples for the :ref:`cellular IoT development <ug_lte>`.
+Additionally, you might want to check the :ref:`memfault_sample` sample and the :ref:`networking_samples`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/crypto.rst b/doc/nrf/samples/crypto.rst
@@ -3,6 +3,14 @@
 Cryptography samples
 ####################
 
+This section lists the available |NCS| samples and tests for the :ref:`nrf_security` and the :ref:`nrfxlib:crypto`, two of the :ref:`security` features of the |NCS|.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/debug.rst b/doc/nrf/samples/debug.rst
@@ -3,6 +3,14 @@
 Debug samples
 #############
 
+This section lists the |NCS| samples useful for :ref:`debugging`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/dect.rst b/doc/nrf/samples/dect.rst
@@ -3,6 +3,14 @@
 DECT NR+ samples
 ################
 
+This section lists the |NCS| samples that showcase the use of the :ref:`nrf_modem_dect_phy` interface of the :ref:`nrfxlib:nrf_modem`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/edge.rst b/doc/nrf/samples/edge.rst
@@ -3,6 +3,14 @@
 Edge Impulse samples
 ####################
 
+This section lists the |NCS| samples for :ref:`integrating Edge Impulse with the nRF Connect SDK <ug_edge_impulse>`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/esb.rst b/doc/nrf/samples/esb.rst
@@ -3,6 +3,14 @@
 Enhanced ShockBurst samples
 ###########################
 
+This section lists the available |NCS| samples for the :ref:`ug_esb` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/fast_pair.rst b/doc/nrf/samples/fast_pair.rst
@@ -3,6 +3,14 @@
 Bluetooth Fast Pair samples
 ###########################
 
+This section lists the |NCS| samples for :ref:`integrating Google Fast Pair with the nRF Connect SDK <ug_bt_fast_pair>`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/gazell.rst b/doc/nrf/samples/gazell.rst
@@ -3,6 +3,14 @@
 Gazell samples
 ##############
 
+This section lists the available |NCS| samples for the :ref:`ug_gz` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/keys.rst b/doc/nrf/samples/keys.rst
@@ -3,6 +3,14 @@
 Keys samples
 ############
 
+This section lists the |NCS| samples related to the :ref:`Hardware unique key (HUK) library <lib_hw_unique_key>`, one of the :ref:`security` features of the |NCS|.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/matter.rst b/doc/nrf/samples/matter.rst
@@ -84,6 +84,12 @@ In addition to these samples, check also the following Matter applications:
 * :ref:`Thingy:53 Matter weather station <matter_weather_station_app>`
 * :ref:`Matter bridge <matter_bridge_app>`
 
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/mesh.rst b/doc/nrf/samples/mesh.rst
@@ -3,6 +3,14 @@
 Bluetooth Mesh samples
 ######################
 
+This section lists the available |NCS| samples for the :ref:`ug_bt_mesh` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/net.rst b/doc/nrf/samples/net.rst
@@ -3,6 +3,16 @@
 Networking samples
 ##################
 
+This section lists the available |NCS| samples for networking development.
+These samples use an nRF91 Series device over LTE or an nRF70 Series device over Wi-Fi® for communication and connection.
+Additionally, you might want to check the :ref:`cellular_samples` and the :ref:`wifi_samples`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/nfc.rst b/doc/nrf/samples/nfc.rst
@@ -3,6 +3,14 @@
 NFC samples
 ###########
 
+This section lists the available |NCS| samples for the :ref:`ug_nfc` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/nrf5340.rst b/doc/nrf/samples/nrf5340.rst
@@ -3,6 +3,12 @@
 nRF5340 samples
 ###############
 
+This section lists the |NCS| samples specific to :ref:`developing with the nRF5340 SoC <ug_nrf53>`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/other.rst b/doc/nrf/samples/other.rst
@@ -3,6 +3,14 @@
 Other samples
 #############
 
+This section lists single |NCS| samples for various uses that are not part of other sections.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/peripheral.rst b/doc/nrf/samples/peripheral.rst
@@ -3,6 +3,14 @@
 Peripheral samples
 ##################
 
+This section lists available |NCS| samples for various peripherals and test tools.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/pmic.rst b/doc/nrf/samples/pmic.rst
@@ -3,6 +3,14 @@
 PMIC samples
 ############
 
+This section lists available |NCS| samples for :ref:`developing with PMICs <ug_pmic>`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/sdfw.rst b/doc/nrf/samples/sdfw.rst
@@ -3,6 +3,14 @@
 SDFW samples
 ############
 
+This section lists available |NCS| samples for :ref:`developing with Secure Domain firmware for nRF54H20 <ug_nrf54h20_architecture_cpu>`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/sensor.rst b/doc/nrf/samples/sensor.rst
@@ -3,6 +3,14 @@
 Sensor samples
 ##############
 
+This section lists available |NCS| samples for sensors that you can use with :ref:`Nordic Thingy:53 <thingy53_app_guide>` and :ref:`Nordic Thingy:91 <ug_nrf91>` prototyping platforms.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/serialization.rst b/doc/nrf/samples/serialization.rst
@@ -3,6 +3,16 @@
 Protocol serialization samples
 ##############################
 
+
+This section lists available |NCS| samples for using remote procedure calls with the :ref:`nrfxlib:nrf_rpc`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/suit.rst b/doc/nrf/samples/suit.rst
@@ -3,6 +3,14 @@
 SUIT samples
 ############
 
+This section lists available |NCS| samples for :ref:`Device Firmware Update using SUIT for the nRF54H Series of System-on-Chip <ug_nrf54h20_suit_dfu>`.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/tfm.rst b/doc/nrf/samples/tfm.rst
@@ -3,6 +3,14 @@
 Trusted Firmware-M (TF-M) samples
 #################################
 
+This section lists the available |NCS| samples and tests for :ref:`ug_tfm`, one of the :ref:`security` features of the |NCS|.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/thread.rst b/doc/nrf/samples/thread.rst
@@ -3,6 +3,14 @@
 Thread samples
 ##############
 
+This section lists the available |NCS| samples for the :ref:`ug_thread` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/wifi.rst b/doc/nrf/samples/wifi.rst
@@ -3,6 +3,14 @@
 Wi-Fi samples
 #############
 
+This section lists the available |NCS| samples for the :ref:`ug_wifi` protocol.
+
+.. include:: ../samples.rst
+    :start-after: samples_general_info_start
+    :end-before: samples_general_info_end
+
+|filter_samples_by_board|
+
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
diff --git a/doc/nrf/samples/zigbee.rst b/doc/nrf/samples/zigbee.rst
diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt
