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: Improve wifi driver docs #1402

Merged
merged 5 commits into from
Jul 18, 2024

Conversation

krish2718
Copy link
Contributor

No description provided.

nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/bus_if/bal/inc/bal_api.h Outdated Show resolved Hide resolved
nrf_wifi/doc/fmac.rst Outdated Show resolved Hide resolved
nrf_wifi/doc/fw_if.rst Outdated Show resolved Hide resolved
nrf_wifi/bus_if/bal/inc/bal_ops.h Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/bus_if/bal/inc/bal_api.h Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/fw_if/umac_if/inc/fmac_tx.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/hal_mem.h Outdated Show resolved Hide resolved
nrf_wifi/fw_if/umac_if/inc/default/fmac_api.h Outdated Show resolved Hide resolved
nrf_wifi/fw_if/umac_if/inc/default/fmac_api.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/fw/rpu_if.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/hal_interrupt.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/hal_interrupt.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/hal_reg.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/hal_structs.h Outdated Show resolved Hide resolved
nrf_wifi/hw_if/hal/inc/hal_structs.h Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
@krish2718
Copy link
Contributor Author

@greg-fer ping

Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

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

The nrf_wifi's README content structure needs to be improved. If not, the right-hand ToC and the left-hand hierarchy in the rendered docs will list both sections and supages and the user will be redirected to a subpage when he or she might expect to be checking a section.

nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/README.rst Outdated Show resolved Hide resolved
nrf_wifi/bus_if/bus/spi/inc/spi.h Outdated Show resolved Hide resolved
Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

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

Most likely last edit from me.

nrf_wifi/doc/layers/overview.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

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

Approving with one nit.

nrf_wifi/doc/layers/overview.rst Outdated Show resolved Hide resolved
This gives a short introduction to basic control and data flow before
delving deep in to the APIs.

Implements SHEL-2887.

Signed-off-by: Chaitanya Tata <[email protected]>
Now that we are exposing all Wi-Fi driver layers, move existing
low-level APIs under FMAC.

Implements SHEL-2887.

Signed-off-by: Chaitanya Tata <[email protected]>
These APIs document driver-firmware interface.

Implements SHEL-2887.

Signed-off-by: Chaitanya Tata <[email protected]>
This is causing doc warning.

Signed-off-by: Chaitanya Tata <[email protected]>
Fix the format for doxygen headers and fix all warnings.

Implements SHEL-2887.

Signed-off-by: Chaitanya Tata <[email protected]>
@rlubos rlubos merged commit 2143e7b into nrfconnect:main Jul 18, 2024
4 checks passed
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