boards/nrf52840dongle docs: Introduce "quick start" section #15658
Conversation
chrysn
added
Type: enhancement
chrysn
added
CI: ready for build
|
Follow-up commit added as the static checks were not happy with the (unmodified) heading level of the nrf52840 docs; I assume the CI checks doxygen warnings were set to stricter since this was originally written. |
chrysn
force-pushed
the
nrf52840dongle-quickstart
branch
from
761abe8 to
5dcfe8c
Compare
|
Removed the follow-up commit again: That wasn't it. Rather, the doxygen version in CI seems to misunderstand the named heading. With version 1.8.20 locally at my site it works (unlike the build artifact), and does not show the error which static tests complain about. |
|
@chrysn ping 😉 |
chrysn
force-pushed
the
nrf52840dongle-quickstart
branch
from
5dcfe8c to
721b88b
Compare
|
Wasn't up there in the list yet ;-) -- but thanks for the nudge. Rebased and now including @jeandudey's solution, let's see what CI makes of it. (My local doxygen is known to produce different results, sadly). |
|
|
Just noticed: there is a typo in the commit message. Would you mind fixing it? |
miri64
changed the title
to mention the board name; also to point to a good first example to use with this board. Closes: RIOT-OS#15654
chrysn
force-pushed
the
nrf52840dongle-quickstart
branch
from
721b88b to
33fc9fa
Compare
Puts "commit message spell checker" on TODO list |
… to mention the board name; also to point to a good first example to use with this board.
Contributes-To: #15654 (which rightfully stated that the board name was not mentioned in the docs, and users should not need to pull it out of the URI.)
Apart from fixing #15654 for the exemplary case, this might also serve as something to generalize. So far, we barely have per-board quickstarts; only the msbiot has something similar (but embedded in the middle of the page and more referring to the family specific wiki page). The conclusions gathered here might serve as input to future structured data on boards.