doc: wifi: Update Building section in samples

richabp · richabp · commit bd696ae0fa9d · 2025-11-24T15:26:58.000+01:00
Added text to refer sample.yaml file in the Building
and running section of all the Wi-Fi samples.

Signed-off-by: Richa Pandey &lt;richa.pandey@nordicsemi.no&gt;
diff --git a/doc/nrf/includes/wifi_refer_sample_yaml_file.txt b/doc/nrf/includes/wifi_refer_sample_yaml_file.txt
@@ -0,0 +1 @@
+Refer to the :file:`sample.yaml` file for a complete list of supported boards and their corresponding build command options.
diff --git a/samples/wifi/ble_coex/README.rst b/samples/wifi/ble_coex/README.rst
@@ -191,6 +191,8 @@ Build for the nRF5340 DK:
 
 The generated HEX file to be used is :file:`throughput/build/merged.hex`.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/monitor/README.rst b/samples/wifi/monitor/README.rst
@@ -56,6 +56,8 @@ Change the board target as given below for the nRF7002 EK.
 
    nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/offloaded_raw_tx/README.rst b/samples/wifi/offloaded_raw_tx/README.rst
@@ -74,6 +74,8 @@ Change the board target as given below for the nRF7002 EK.
 
    west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/promiscuous/README.rst b/samples/wifi/promiscuous/README.rst
@@ -64,6 +64,8 @@ Change the board target as given below for the nRF7002 EK.
 
    nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/provisioning/ble/README.rst b/samples/wifi/provisioning/ble/README.rst
@@ -112,6 +112,8 @@ The sample generates header and source files based on protocol buffer definition
 You must install a protocol buffer compiler to generate the files.
 See the :zephyr:code-sample:`nanopb` in the Zephyr documentation for more information.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/provisioning/internal/README.rst b/samples/wifi/provisioning/internal/README.rst
@@ -266,6 +266,8 @@ To build and run the sample, complete the following steps:
        uart:~$ wifi_prov get_status
        uart:~$ wifi_prov raw 0801
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/provisioning/softap/README.rst b/samples/wifi/provisioning/softap/README.rst
@@ -61,6 +61,8 @@ Building and running
 
 .. include:: /includes/build_and_run_ns.txt
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/radio_test/multi_domain/sample_description.rst b/samples/wifi/radio_test/multi_domain/sample_description.rst
@@ -70,6 +70,8 @@ The following is an example of the CLI command:
 
 See also :ref:`cmake_options` for instructions on how to provide CMake options.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Dependencies
 ************
 
diff --git a/samples/wifi/radio_test/single_domain/sample_description.rst b/samples/wifi/radio_test/single_domain/sample_description.rst
@@ -63,6 +63,8 @@ The following is an example of the CLI command:
 
 See also :ref:`cmake_options` for instructions on how to provide CMake options.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 See the :ref:`Peripheral radio test sample <radio_test>` for detailed documentation on the related features.
 
 Dependencies
diff --git a/samples/wifi/raw_tx_packet/README.rst b/samples/wifi/raw_tx_packet/README.rst
@@ -144,6 +144,8 @@ Change the board target as given below for the nRF7002 EK.
 
    nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/scan/README.rst b/samples/wifi/scan/README.rst
@@ -76,6 +76,8 @@ The following are examples of the CLI commands:
 
    west build -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS=y
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/shell/README.rst b/samples/wifi/shell/README.rst
@@ -113,6 +113,8 @@ The following is an example of the CLI commands:
 
 See also :ref:`cmake_options` for instructions on how to provide CMake options.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Supported CLI commands
 ======================
 
diff --git a/samples/wifi/shutdown/README.rst b/samples/wifi/shutdown/README.rst
@@ -151,6 +151,8 @@ Buttons mode
 
     west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000 -DCONFIG_OPERATION_MODE_BUTTONS=y
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/softap/README.rst b/samples/wifi/softap/README.rst
@@ -78,6 +78,8 @@ The following is an example of the CLI command:
 
 To build for the nRF7002 EK with nRF5340 DK, use the ``nrf5340dk/nrf5340/cpuapp`` board target with the ``SHIELD`` CMake option set to ``nrf7002ek``.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/sta/README.rst b/samples/wifi/sta/README.rst
@@ -96,15 +96,15 @@ Building and running
 
 .. include:: /includes/build_and_run_ns.txt
 
-Currently, only the nRF7002 DK is supported.
-
 To build for the nRF7002 DK, use the ``nrf7002dk/nrf5340/cpuapp`` board target.
 The following is an example of the CLI command:
 
 .. code-block:: console
 
    west build -b nrf7002dk/nrf5340/cpuapp
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 
diff --git a/samples/wifi/thread_coex/README.rst b/samples/wifi/thread_coex/README.rst
@@ -173,6 +173,7 @@ Add the following SHIELD options for the nRF7002 EK and nRF7001 EK.
 
 The generated HEX file to be used is :file:`thread_coex/build/merged.hex`.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
 
 Testing
 =======
diff --git a/samples/wifi/throughput/README.rst b/samples/wifi/throughput/README.rst
@@ -103,6 +103,8 @@ To build for the nRF7002 DK with different profiles for Station mode, use the fo
 
          west build -p -b nrf7002dk/nrf5340/cpuapp -- -DEXTRA_CONF_FILE=overlay-rx-prio.conf
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Supported CLI commands
 ======================
 
diff --git a/samples/wifi/twt/README.rst b/samples/wifi/twt/README.rst
@@ -86,15 +86,15 @@ Building and running
 
 .. include:: /includes/build_and_run_ns.txt
 
-Currently, only the nRF7002 DK is supported.
-
 To build for the nRF7002 DK, use the ``nrf7002dk/nrf5340/cpuapp`` board target.
 The following is an example of the CLI command:
 
 .. code-block:: console
 
    west build -b nrf7002dk/nrf5340/cpuapp
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 .. important::
 
    It is mandatory to set the :kconfig:option:`CONFIG_TRAFFIC_GEN_REMOTE_IPV4_ADDR` Kconfig option to the IPv4 address of the host running the traffic generator server. If this is set incorrectly, the sample may fail to work as expected.
diff --git a/samples/wifi/wfa_qt_app/README.rst b/samples/wifi/wfa_qt_app/README.rst
@@ -98,6 +98,8 @@ The following is an example of the CLI command:
 
 See also :ref:`cmake_options` for instructions on how to provide CMake options.
 
+.. include:: /includes/wifi_refer_sample_yaml_file.txt
+
 Testing
 =======
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Refer to the :file:`sample.yaml` file for a complete list of supported boards and their corresponding build command options.