[riot-notifications] [RIOT-OS/RIOT] [RFC-WIP] docs: move wiki's Board documentation to Doxygen (#8508)

jia200x notifications at github.com
Fri Feb 2 13:32:47 CET 2018


@aabadie:
> I would rather add a doc.txt file in each board directory see the feather-m0 or some arduino-mkr for example. The doc.txt can contain Markdown compatible documentation.
You can also use doxygen commands (@ref, @see, etc) to nicely link things (CPU, boards, drivers) in the documentation.

I tend to like the idea, but is it possible to somehow have the same structure as the wiki with this approach? E.g, append [the SAMR21 Board entry]() to the [wiki entry]() and have all the information in the same page?

> I don't think adding a new menu entry in the top menu makes sense, just reuse the existing doxygen boardsgroup

IMO Supported Boards is more than a single entry in the Modules group. E.g the [openthread.io](https://openthread.io/platforms/) and [contiki-os.org](http://www.contiki-os.org/hardware.html) sites have both an exposed entry to the supported platform.

Not sure if should be a link to the Boards group, but I think it's important to have at least a page with all info related to Supported Boards.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/8508#issuecomment-362574455
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20180202/3517ad91/attachment.html>


More information about the notifications mailing list