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

boards/nrf52840dongle docs: Introduce "quick start" section #15658

Merged

Conversation

chrysn
Copy link
Member

@chrysn chrysn commented Dec 17, 2020

… 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.

@chrysn chrysn added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Area: boards Area: Board ports labels Dec 17, 2020
@chrysn chrysn added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Dec 17, 2020
@chrysn
Copy link
Member Author

chrysn commented Dec 17, 2020

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
Copy link
Member Author

chrysn commented Dec 17, 2020

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.

@MrKevinWeiss MrKevinWeiss added this to the Release 2021.07 milestone Jun 21, 2021
@MrKevinWeiss MrKevinWeiss removed this from the Release 2021.07 milestone Jul 15, 2021
@benpicco
Copy link
Contributor

@chrysn ping 😉

@chrysn
Copy link
Member Author

chrysn commented Aug 25, 2021

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).

@miri64
Copy link
Member

miri64 commented Aug 25, 2021

(My local doxygen is known to produce different results, sadly).

Seems to work now.

@miri64
Copy link
Member

miri64 commented Aug 25, 2021

Just noticed: there is a typo in the commit message. Would you mind fixing it?

@miri64 miri64 changed the title boards/nrf52840dongle docs: Intoduce "quick start" section boards/nrf52840dongle docs: Introduce "quick start" section Aug 25, 2021
to mention the board name; also to point to a good first example to use
with this board.

Closes: RIOT-OS#15654
@chrysn
Copy link
Member Author

chrysn commented Aug 25, 2021

Thanks, fixed. (And apologies to @maribu whose #16023 I've CI-toggled to get this 20-second job to run before the 20-minute one, just so I can merge it right away).

@chrysn chrysn merged commit 5497c1c into RIOT-OS:master Aug 25, 2021
@chrysn chrysn deleted the nrf52840dongle-quickstart branch August 25, 2021 17:48
@miri64
Copy link
Member

miri64 commented Aug 25, 2021

Just noticed: there is a typo in the commit message. Would you mind fixing it?

Puts "commit message spell checker" on TODO list

@benpicco benpicco added this to the Release 2021.10 milestone Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: boards Area: Board ports Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants