Documentation Unification Effort

apache / nuttx

Apache NuttX is a mature, real-time embedded operating system (RTOS)

https://nuttx.apache.org/

Apache License 2.0

2.89k stars 1.18k forks source link

Documentation Unification Effort #9094

Open btashton opened 1 year ago

btashton commented 1 year ago

This ticket tracks the effort to unify the documentation in one place.

[ ] Port remaining CWIKI guides and documentation to sphinx (will add list of pages for tracking)
[ ] Port remaining Board readme.txt (will add list of pages for tracking)
[ ] Port and de-duplicate content in top level readme.txt
[ ] Port and deduplicate misc readme.txt files

btashton commented 1 year ago

I will start filling out the meat of this ticket in a few days and then start with the CWIKI pages. I will need help of others to make sure the content I update is clear and still accurate.

@patacongo @xiaoxiang781216 @pkarashchenko your reviews especially would be appreciated for the OS internals that have changed since much of these wiki docs were last updated.

cederom commented 1 year ago

+1 i am here to help :-)