Skip to content
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.

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

Wifi ready doc changes #15765

Closed
wants to merge 3 commits into from

Conversation

D-Triveni
Copy link
Contributor

No description provided.

@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Jun 5, 2024
@D-Triveni D-Triveni added this to the 2.7.0 milestone Jun 5, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jun 5, 2024

Test specification

CI/Jenkins/NRF

  • Skipped

CI/Jenkins/integration

  • Skipped

Note: This message is automatically posted and updated by the CI

@richabp
Copy link
Contributor

richabp commented Jun 5, 2024

Need to fix the issue with doxygengroup to remove the build error.

@kittydepa
Copy link

Need to fix the issue with doxygengroup to remove the build error.

@D-Triveni I believe this can be done by running "west update", then "git commit --amend" and pushing again.

samples/wifi/sta/README.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/networking/wifi_ready.rst Outdated Show resolved Hide resolved
samples/wifi/sta/README.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/networking/wifi_ready.rst Outdated Show resolved Hide resolved
samples/wifi/sta/README.rst Outdated Show resolved Hide resolved
samples/wifi/sta/README.rst Outdated Show resolved Hide resolved
samples/wifi/sta/README.rst Outdated Show resolved Hide resolved
samples/wifi/sta/README.rst Outdated Show resolved Hide resolved
Add changelog entry for the changes done in `station` sample.

Signed-off-by: Triveni Danda <[email protected]>
Add RPU recovery testing section.

Signed-off-by: Triveni Danda <[email protected]>
Add changelog entry for the `wifi_ready` library.

Signed-off-by: Triveni Danda <[email protected]>
@@ -907,6 +911,12 @@ Libraries for networking
* Function :c:func:`wifi_credentials_is_empty` to check if the Wi-Fi credentials storage is empty.
* New parameter ``channel`` to the structure :c:struct:`wifi_credentials_header` to store the channel information of the Wi-Fi network.

* Added the :ref:`lib_wifi_ready` library that manages Wi-Fi readiness for applications by handling supplicant ready and not ready events.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just have bullet "Added" after the Libraries for networking heading and the two entries (softap provision and this) under it similarly to the existing softap provisioning entry. Like this:

  • Added:

    • :ref:lib_softap_wifi_provision library.
    • :ref:lib_wifi_ready library

Comment on lines +916 to +918
* :ref:`lib_wifi_ready` library:

* Notifies applications of Wi-Fi readiness by managing supplicant events, indicating when Wi-Fi is available for use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`lib_wifi_ready` library:
* Notifies applications of Wi-Fi readiness by managing supplicant events, indicating when Wi-Fi is available for use.

@krish2718
Copy link
Contributor

Cherry-picked these to #15628

@krish2718 krish2718 closed this Jun 6, 2024
@D-Triveni D-Triveni reopened this Jun 6, 2024
@D-Triveni D-Triveni closed this Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants