Feedback on Autoware.Auto documentation
Feedback from a discussion with an interested power user on June 16, 2021
- the process to create a point-cloud map for NDT is not well described
- the process to create a Lanelet2 map is not described at all
- the usage demos are very descriptive and clear but don't give much background on how it works. More pointers to the design docs would help as well as overview diagrams of which nodes are involved and the topics and message types. So one can check and compare with output from
rqt
orros2 topic list
- he missed a section in the docs for details about packages. It's actually here but that name is not conventional so he missed it. He was looking for API but there is only the doxygen auto-generated API documentation.
- each design doc should have node parameters, explain how users can tweak/customize the node, message types and input/output topics
- overview diagrams like in #942 are really great, just missing the topic names. We will add them after the next demo when the design has finalized
- great that we make an effort to document everything