cncserver icon indicating copy to clipboard operation
cncserver copied to clipboard

Documentation

Open techninja opened this issue 5 years ago • 0 comments

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

techninja avatar Jul 03 '20 22:07 techninja