Skip to content

Documentation #110

@techninja

Description

@techninja

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions