[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. If there are hardware dependencies of the Package, are these documented?
    • N/A
  5. Is it clear to an outside user what the roadmap is for the Package?
    • No
  6. Is it clear to an outside user what the stability is for the Package?
    • No
  7. Are concepts introduced by the Package well illustrated?
    • Yes

Concerns / issues

I'm not sure of the proper way to document a packages roadmap and stability. Those two items are the only two things missing.


Good documentation, illustrations, and tutorials.

kwc: marking as doc reviewed

2024-05-11 13:42