kbase / dts

A data transfer service
https://kbase.github.io/dts/
MIT License
0 stars 0 forks source link

Figure out how to automatically include generated REST API documentation in the doc site #64

Closed jeff-cohere closed 3 months ago

jeff-cohere commented 6 months ago

Suggested by @ialarmedalien , and a very good idea:

export and save the API docs that huma produces and add them to the DTS docs (ideally using the magic of github actions, rather than having to do it manually)

jeff-cohere commented 5 months ago

Here's an interesting link: https://blog.stoplight.io/pdf-api-documentation

jeff-cohere commented 5 months ago

The short story on this issue seems to be that persistent generated API documentation seems not to be "a thing." There are various providers of generated API documentation, and they all seem to want everyone to flock to their platforms to get hosted documentation. I wonder if it's sufficient (once we have a "permanently hosted" DTS instance) to just link to the online docs, since they're already formatted properly.