Skip to content

Commit

Permalink
doc: Add sample docs
Browse files Browse the repository at this point in the history
This was missed initially, but quite handy.

Signed-off-by: Chaitanya Tata <[email protected]>
  • Loading branch information
krish2718 committed Jan 9, 2025
1 parent 672bc38 commit 4e4055a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
1 change: 1 addition & 0 deletions nrf70_bm_lib/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Welcome to the nRF70 Bare Metal library documentation!
nrf70_bm_porting_guide
nrf70_bm_api
nrf70_bm_lib_migration_guide
samples


Indices and tables
Expand Down
14 changes: 14 additions & 0 deletions nrf70_bm_lib/docs/source/samples.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _nrf70_bm_samples:

Samples
#######

The nRF70 BM repo provides samples that specifically target Nordic Semiconductor devices and show how to implement typical use cases with Nordic Semiconductor libraries and drivers.
Samples showcase a single feature or library.
These samples are a good starting point for understanding how to put together your own application.

.. toctree::
:maxdepth: 1
:caption: Samples

samples_docs
2 changes: 2 additions & 0 deletions nrf70_bm_lib/docs/source/samples_docs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../samples/scan_bm/README.rst
.. include:: ../../../samples/radio_test_bm/README.rst

0 comments on commit 4e4055a

Please sign in to comment.