[Documentation] [TitleIndex] [WordIndex

web_apps_core/Reviews/2010-01-18_Doc_Review

Reviewer:

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. The only interface we're supporting is use over the web, which should be self-documenting (I'm relying on use-case results for that)
  3. No tutorials, but instructions to get going on the web interface should be enough.
  4. No packages have APIs to review
  5. The documentation is light, but works with the StackDocumentation guidelines. The only issue is inconsistent scoping to "pr2" instead of "the robot" for expected / compatible hardware.

  6. All packages in the stack belong.

Concerns / issues

Conclusion

I'm OK with this after:


2022-05-28 12:54