search

fermyon / spin-js-sdk

https://developer.fermyon.com/spin/javascript-components
Apache License 2.0
52 stars 18 forks source link

Add documentation comments for TypeScript SDK #129

Closed radu-matei closed 1 month ago

radu-matei commented 1 year ago

ref https://tsdoc.org/

karthik2804 commented 1 year ago

There are some issues with this because of the way the SDK is setup. typedoc spits out only the documentation for the exported items which in our case is a very small subset of the API (4 interfaces recalling from memory). I need to look into the plugin ecosystem to see if I can find something that we can use to export all the required interfaces. if not we may need to write our own plugin or build on top of tsdoc.

karthik2804 commented 1 month ago

The new SDK comes with tsdoc and the docs are published to https:/fermyon.github.io/spin-js-sdk the v1 SDK docs can be found at https:/fermyon.github.io/spin-js-sdk/v1