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.

Sign up for GitHub

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

Jump to bottom

Documentation #110

Open
3 tasks
techninja opened this issue Jul 3, 2020 · 0 comments
Open
3 tasks

Documentation #110

techninja opened this issue Jul 3, 2020 · 0 comments

Comments

@techninja
Copy link
Owner

techninja commented Jul 3, 2020 •
edited
Loading

The most important thing an API needs is documentation. If examples aren't given clearly, then it won't be used. ALso since we provide a default implementation, that needs its own documentation.

Gitbook seems to be pretty popular, so I'm going to try to do it with that.

  • API documentation: examples for every single endpoint and its expected variants and errors
  • Show API data schema and how to read it
  • Document visually how to use the default UI to do basic to advanced things
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@techninja