Documentation & HOWTO requests

IBM / report-toolkit

A toolkit for consumers of Node.js diagnostic Reports

https://ibm.github.io/report-toolkit

Other

84 stars 10 forks source link

Closed boneskull closed 4 years ago

boneskull commented 5 years ago

Documentation needs/wants:

[x] Provide TypeScript definitions
[x] Provide user API documentation
[ ] Provide plugin author API documentation
[ ] Provide configuration documentation
[ ] Provide HOWTOs:
- [ ] Redact a report running on Cloud Provider X
- [ ] Build a Rule
- [ ] Run as a service
- [ ] Use in browser

Some of these may be absolutely essential, and some are nice-to-have, but there's a list.

boneskull commented 4 years ago

this has been broken up into several issues, see documentation project