RIOT-OS / RIOT

RIOT - The friendly OS for IoT
https://riot-os.org
GNU Lesser General Public License v2.1
4.83k stars 1.97k forks source link

boards/nRF: Make documentation more consistent and updated #20592

Open crasbe opened 2 months ago

crasbe commented 2 months ago

Description

The documentation for the Nordic Semiconductor nRF boards is in a somwhat inconsistent shape. This makes it harder to get started with these particular boards. Some features of the boards that RIOT supports are not mentioned in the documentation etc. And it seems like they suffered a bit of bit rot and some information has to be updated.

Please do let me know if you see more potential tasks to do. I'll get started on this next week(-ish).

Useful links

https://doc.riot-os.org/group__boards__common__nrf52.html https://doc.riot-os.org/group__boards__nrf52dk.html https://doc.riot-os.org/group__boards__nrf52840dk.html https://doc.riot-os.org/group__boards__nrf52840dongle.html https://doc.riot-os.org/group__boards__nrf52832-mdk.html https://doc.riot-os.org/group__boards__nrf51dk.html https://doc.riot-os.org/group__boards__nrf51dongle.html

Stuff about the nRF6310: https://doc.riot-os.org/group__boards__nrf6310.html https://developer.nordicsemi.com/nRF51_SDK/nRF51_SDK_v4.x.x/doc/html/group__nrf51__setups.html#nrf51_setup_nrf6310 https://web.archive.org/web/20191031043659/http://www.mommosoft.com/blog/category/nrf51822/

crasbe commented 2 months ago

@mguetschow the last ToDo item was meant for the boards that currently have no information about NFC at all (like the nRF52DK, nRF52840DK, ..?) So it is not quite done yet, but I added a reference to your PR so I could keep it in mind to add it :D