[GitHub] [incubator-nuttx] Ouss4 commented on issue #2409: Properly document each arch, SoC family and board

[GitBox <gi...@apache.org>]

Ouss4 commented on issue #2409:
URL: https://github.com/apache/incubator-nuttx/issues/2409#issuecomment-734500205


   I think we can start by the boards (point (3)) and work our way up.  Documenting everything in arch or the different chips can be daunting.  At least, we can just list the devices/features that are supported.
   
   In the old documentation, we had an HTML table that groups all the supported architectures, chips and boards and then some descriptive details where given in a section below.
   The  boards READMEs are more for technical details, they show how to run the configs and how to overcome certain issues.
   
   For the boards, we can group all the information in one document as suggested.  We would end up with something similar to the Zephyr example.
   
   > I think making sure people update the docs is just something we need to get in a habit of during the review process.
   
   Yes, we really need to do that.  In the previous 2 releases we had to update the documents during the preparation of the release notes.  That was somewhat painful as things can accumulate.
   
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org