launchdarkly / electron-client-sdk

LaunchDarkly Client-side SDK for Electron
Other
4 stars 9 forks source link

Generated documentation for the SDK #3

Closed eli-darkly closed 5 years ago

eli-darkly commented 5 years ago

Although the Electron SDK contains documentation comments (in the TypeScript declarations), they haven't been viewable anywhere except in IDEs. We are planning to put TypeDoc-generated docs online. If you'd like to watch this issue, we will update it when the docs go online.

eli-darkly commented 5 years ago

TypeDoc documentation is now published at https://launchdarkly.github.io/electron-client-sdk/ for the most recent release (1.1.0), and will be updated with each release. We don't yet have versioned documentation, but that's on the list.