Skip to content

doc: wifi: Fix doc error in Station sample #25718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 25, 2025
Merged

doc: wifi: Fix doc error in Station sample #25718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/nrf/includes/wifi_refer_sample_yaml_file.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Refer to the :file:`sample.yaml` file for a complete list of supported boards and their corresponding build command options.
2 changes: 2 additions & 0 deletions samples/wifi/ble_coex/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/monitor/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/offloaded_raw_tx/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/promiscuous/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/provisioning/ble/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/provisioning/internal/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/provisioning/softap/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ Building and running

.. include:: /includes/build_and_run_ns.txt

.. include:: /includes/wifi_refer_sample_yaml_file.txt

Testing
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/radio_test/multi_domain/sample_description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
************

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/radio_test/single_domain/sample_description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/raw_tx_packet/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/scan/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/shell/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
======================

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/shutdown/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/softap/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
4 changes: 2 additions & 2 deletions samples/wifi/sta/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down
1 change: 1 addition & 0 deletions samples/wifi/thread_coex/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======
Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/throughput/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
======================

Expand Down
4 changes: 2 additions & 2 deletions samples/wifi/twt/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions samples/wifi/wfa_qt_app/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down