[Documentation] [TitleIndex] [WordIndex



Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. Do relevant usages have associated tutorials?
  4. Have all Packages in the Stack been API reviewed?

  5. Does the Stack conform to the StackDocumentation guidelines?

  6. Are there Packages in the Stack that don't belong

Concerns / issues

Josh T.

  1. The report bug and request features links need to be updated
    • (./) Fixed.

  2. In the section on PS3 pairing, perhaps we should add a note that there's no actual confirmation that the pairing has happened? Many users have been confused while waiting to find out if they have successfully paired or not.
    • (./) Fixed.


  1. The pr2_teleop instructions needed a small bit of fixing.
    • (./) Fixed.

  2. The tuckarm instructions needed more information about how you know if it has run properly.
    • (./) Fixed.

  3. The tutorials do not exist, but they are present in simple form on the main package pages.


The only required action is updating the bug and feature request links. The comment on pairing notification is optional.

2024-06-15 12:59