v01d commented on pull request #1955: URL: https://github.com/apache/incubator-nuttx/pull/1955#issuecomment-707694122
> > The docs look fine, albeit there should also be some explanation inside the first section of _what_ the note driver does. Keep in mind that not everyone (as me) is aware of what it does and how it works. > > I was looking forward to have the docs you linked here: https://github.com/YuuichiNakamura/nuttx-task-tracer-doc > > with all those nice figures and explanations. > > Ok. I'll add an explanation of note driver on the top of note.rst. > Regarding the another part of my document, how about adding them to Documentation/guides ? It seems a preferable place for the introduction. I'd always prefer to complete the reference sections before adding stuff to the guides. But if you prefer to have it there, go ahead. The main image could be added to the doc page of this PR in any case. > > And, should I leave a instruction of "trace" command line options in apps/system/trace/README.md ? I couldn't find a preferable place to explain the built-in command line options in Documentation/. Or should I move it into Documentation/guides with other instructions (Installation, Quick start guide, ... etc) Builtin commands are described here: https://nuttx.apache.org/docs/latest/components/nsh/commands.html This section is fairly large and eventually should be split for readability. Remember that you can use the search to find where things are documented. ---------------------------------------------------------------- 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: us...@infra.apache.org
