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

API documentation format/location #290

Open
stuarteberg opened this issue Sep 10, 2018 · 0 comments
Open

API documentation format/location #290

stuarteberg opened this issue Sep 10, 2018 · 0 comments
Labels
documentation comments on documentation or papers enhancement

Comments

@stuarteberg
Copy link
Member

Client libraries that wrap or heavily use DVID endpoints should mention (in their own documentation) which DVID endpoints they are wrapping/using. To that end, it would be nice if they could include links to the DVID documentation for various endpoints.

The DVID API is extensively documented via .../api/help, but there are couple of issues with the current scheme:

  1. At the moment, the dvid docs are self-hosted by each DVID server. It would be nice if we hosted a copy of them in a permanent location, so that other projects could link to them.
  2. The docs are plaintext, so it is not currently possible to link to specific sections (e.g. for a particular endpoint)
@stuarteberg stuarteberg added enhancement documentation comments on documentation or papers labels Sep 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation comments on documentation or papers enhancement
Projects
None yet
Development

No branches or pull requests

1 participant