Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation! #54

Open
cansavvy opened this issue Jan 11, 2024 · 0 comments
Open

Documentation! #54

cansavvy opened this issue Jan 11, 2024 · 0 comments

Comments

@cansavvy
Copy link
Collaborator

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant