Restructure sample documentation #511
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
7 times, most recently
from
450728d to
9444d56
Compare
Restructure sample documentation, removing common stuff from sample to separat section. Signed-off-by: Bjørn Tore Taraldsen <[email protected]>
bjorn-tore-taraldsen
force-pushed
the
refactor_sample_doc
branch
from
9444d56 to
4b029b6
Compare
| Getting Started with the Samples | ||
| ################################ | ||
|
|
||
| This section is a general description of how you can explore and try out the samples provided with the nRF Connect SDK. |
Contributor
There was a problem hiding this comment.
Suggested change
| This section is a general description of how you can explore and try out the samples provided with the nRF Connect SDK. | |
| This section is a general description of how you can explore and try out the samples provided with the |BMlong|. |
| ################################ | ||
|
|
||
| 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. | |
| It describes how you can create a copy of a sample, configure it, build it, and program it to test it running on a Nordic DK. |
| By selecting the build folder in the Application View, nRF Connect extension in VS Code will automatically program ALL images listed in that build configuration. | ||
| For a Simple Board variant, the build folder will list both the application and the SoftDevice, and a Flash command will flash both. | ||
| Equally for a MCUboot variant, the Flash command will flash all the images needed. | ||
|
|
Contributor
There was a problem hiding this comment.
I think it would be useful to show a screenshot of an example here.
|
|
||
| Programming the S115 SoftDevice | ||
| ******************************* | ||
| Playing with the sample |
Contributor
There was a problem hiding this comment.
In sdk-nrf the equivalent title here is Building and running.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.