fhdsl/metricminer

Documentation!

Opened this issue · 0 comments

There's a few forms of docs we need here:

  1. The @returns are pretty vague at this point. They could use some boosting and better descriptions.
  2. We need tutorials for each app -- and we need to think about the organization of this.

Notes about approaches:

  • We want to be specific enough about the data to be helpful but not so specific that when the API changes that we are left with a lot of maintenance work.
  • We'll need screenshots to show people how to set up credentials.
  • Note about the flexible prescriptivity. -- You can use metricminer as is or you can use the dataformat = "raw" or not use the dashboard template and do your own thing.