• kwc
  • gerkey

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?
    • kwc: yes
  2. Are all of these APIs documented?
    • kwc: yes (except calibration seems to have more to do)
  3. Do relevant usages have associated tutorials?
    • kwc: yes
  4. Have all Packages in the Stack been API reviewed?

    • kwc: setup review for stereo_msgs. camera_calibration not complete yet
  5. Does the Stack conform to the StackDocumentation guidelines?

    • kwc: yes
  6. Are there Packages in the Stack that don't belong
    • kwc: no

Concerns / issues


  • This needs a roadmap to generally describe where its headed.
  • removed some pr2-specific language in (stereo)_image_proc
  • looks like tutorial has been subsumed into other stacks, even as I type, so all good there


Wiki: image_pipeline/Reviews/2010-01-18_Doc_Review (last edited 2010-01-19 00:49:49 by KenConley)