Restructure sample documentation #511
Conversation
github-actions
bot
added
changelog-entry-required
|
You can find the documentation preview for this PR here. |
bjorn-tore-taraldsen
force-pushed
the
refactor_sample_doc
branch
8 times, most recently
from
9444d56 to
4b029b6
Compare
This comment was marked as outdated.
This comment was marked as outdated.
doc/nrf-bm/sample/intro.rst
Outdated
| ################################ | ||
|
|
||
| This section is a general description of how you can explore and try out the samples provided with the nRF Connect SDK. | ||
| It describes how you can create a copy of your sample, configure it, build and program the samples to test it running on a Nordic DK’s. |
There was a problem hiding this comment.
Is the user really supposed/expected to create a sample? Samples are something to run as-is to test and experiment with a some functionality. When the user wants to create their own application they can use a sample as a starting point I suppose, but this procedure is different from just running one of the samples directly-- and they are not creating a sample but an application.
bjorn-tore-taraldsen
force-pushed
the
refactor_sample_doc
branch
4 times, most recently
from
060ae18 to
372adab
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
b-gent
force-pushed
the
refactor_sample_doc
branch
4 times, most recently
from
7b880ca to
98828a6
Compare
b-gent
force-pushed
the
refactor_sample_doc
branch
from
98828a6 to
516f375
Compare
b-gent
force-pushed
the
refactor_sample_doc
branch
from
516f375 to
58bb0c5
Compare
|
|
||
| You will need the following information: | ||
|
|
||
| * The |NCS| version and toolchain version that the current |BMshort| release is based on: |ncs_release| |
There was a problem hiding this comment.
For release PR, ncs_release must be updated.
|
|
||
| .. note:: | ||
| This will also be the case for the Peripheral samples where we do not need a SoftDevice. | ||
| Reason for this is the selected board target and that we have decided to not have any board targets without SoftDevice included. |
There was a problem hiding this comment.
| Reason for this is the selected board target and that we have decided to not have any board targets without SoftDevice included. | |
| Reason for this is the selected board target and that we have chosen to not have any board targets without SoftDevice included. |
There was a problem hiding this comment.
I rewrote this one to:
This is because the SDK does not include board targets without the SoftDevice, in order to reduce complexity.
@eivindj-nordic @bjorn-tore-taraldsen let me know if it works
|
|
||
| .. include:: /includes/softdevice_flash.txt | ||
|
|
||
| .. _ble_bms_sample_testing: |
There was a problem hiding this comment.
Cleanup.
| .. _ble_bms_sample_testing: |
I see this tag to sample testing is removed from lots of the other samples. Remove it here and in ble_hrs_central/README.rst, ble_mcuboot_recovery_entry/README.rst and ble_mcuboot_recovery_retention/README.rst as well? I cannot see the tags being used anywhere (Double check this).
There was a problem hiding this comment.
this is very low priority and doesn't affect output, I will postpone this to the release PR
b-gent
force-pushed
the
refactor_sample_doc
branch
2 times, most recently
from
451d930 to
27651b4
Compare
samples/peripherals/timer/README.rst
Outdated
| :depth: 2 | ||
|
|
||
| The Timer sample demonstrates the use of both single-shot and periodic timers. | ||
| The Timer sample demonstrates how to configure and use the Bare Metal Timer (ref:`lib_bm_timer`) library to generate both single-shot and periodic callback events to your application code. |
There was a problem hiding this comment.
Link (lib_bm_timer) is broken.
Restructure sample documentation, removing common stuff from sample to separate reference section. Signed-off-by: Bjørn Tore Taraldsen <[email protected]>
b-gent
force-pushed
the
refactor_sample_doc
branch
from
27651b4 to
a72b9e4
Compare
6 participants
No description provided.