[Documentation] [TitleIndex] [WordIndex



Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
    • Yes
  2. Are all of these APIs documented?
    • Yes
  3. Do relevant usages have associated tutorials? (you can ignore this if a Stack-level tutorial covers the relevant usage), and are the indexed in the right places?
    • Yes
  4. Is it clear to an outside user what the roadmap is for the Package?
    • Yes
  5. Is it clear to an outside user what the stability is for the Package?
    • Yes
  6. Are concepts introduced by the Package well illustrated?
    • Yes

Concerns / issues

The documentation for roscreate-pkg should probably mention that the path in which you run the command matters. The other ros tools need the newly created package to exist in an existing package path.


Doc reviewed

2024-06-15 13:46