v01d opened a new issue #1638: URL: https://github.com/apache/incubator-nuttx/issues/1638
These are the pending tasks to complete the new documentation: - [ ] devise the CI workflows necessary to have this published on nuttx website. documentation should be deployed for master and for every tagged release. The documentation itself allows to choose which version to read (see mockup dropdown just above search field in documentation) - [ ] fill supported boards section using content from current README files - [ ] autogenerate the list of supported platforms based on all boards existing on the repo - [ ] allow the docs to pickup information from the application repo so that applications are also documented (or at least initially, listed) - [ ] look into defining a workflow which would build documentation for each PR somewhere (github pages for the nuttx repo?) so that previewing a PR is simple. Various parts of the documentation require writing new content (possibly already existing in other external sources): - [ ] quickstart: this is a very important section for newcomers. this guide should give instructions on how to try nuttx on a commonly available board with good support for nuttx (some stm32 nucleo/discovery?). - [ ] introduction -> development environments: check if this is still up to date and revise whether any given particular toolchain should be recommended. this also requires a bit of rewrite to be more like a documentation and not simply a report of toolchain support status. - [ ] introduction -> trademarks: revise this. it mentions NuttX to be trademarked which I'm not sure it is still true. - [ ] releases: if the release notes file was in markdown we could directly include it here. anyway, it is quite large so it may be better to only hold release notes of latest version (I believe this was discussed before) - [ ] start looking into the wiki, looking for information that should be converted to documentation of a subsystem not currently documented and for guides for the corresponding section. providing documentation for a subsystem should be prioritized over just providing a guide covering a particular use case. Feel free to suggest new tasks or discuss the ones already listed. ---------------------------------------------------------------- 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: [email protected]
