On Wed, Jul 15, 2020, at 22:45, Brennan Ashton wrote:
> I would be huge fan of this.  It makes it a lot more approachable, I had
> started converting the main readme in particular but I did not get very
> far. It's a lot of work.

I can help with that if you want

> Did you see Adams work here
> https://nuttx-companion.readthedocs.io/en/latest/
> 
> I thought it would be really nice to integrate the board list with the
> readme content into it. (While keeping the content readable in the source
> control).

Yes, I was actually imagining some sort of CI command on the website (not sure 
the wiki handles that) that could build a list with all boards containing a 
README, link to it and display it there nicely formatted. Something like 
readthedocs could possibly do it already, not sure.

One of the reasons I really like the Zephyr docs is because of this, you can 
see how they present their supported boards there: 
https://docs.zephyrproject.org/latest/boards/index.html
Even further, each board description has a nice picture, specification list, 
etc. I thank that would be really useful and easy to do (the picture could be 
stored in some stable location and the README simply link to it).

Best,
Matias

Reply via email to