pr2_ogre/Reviews/2010-01-20_Doc_Review
Reviewer:
- kwc
Instructions for doing a doc review
See DocReviewProcess for more instructions
- Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
- Are all of these APIs documented?
- 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?
- Is it clear to an outside user what the roadmap is for the Package?
- Is it clear to an outside user what the stability is for the Package?
- Are concepts introduced by the Package well illustrated?
Concerns / issues
kwc
I added note on proper GAZEBO_RESOURCE_PATH
I also added a summary of what was actually provided
Conclusion
Doc reviewed, assuming John approves of fixes