amilajack / react-wavesurfer.js

React bindings for wavesurfer.js

https://amilajack.github.io/react-wavesurfer.js

MIT License

11 stars 5 forks source link

add typedoc support #9

Open amilajack opened 3 years ago

hamirmahal commented 3 years ago

I'd like to try this. How should I get started?

amilajack commented 3 years ago

Sure! Here's some examples:

https://github.com/amilajack/joker https://typedoc.org/

We'll need to figure out how to host both typedoc and storybook. Maybe we could host typedoc in a different subdirectory. I also recommend working on storybook integration before this so that we can figure out how we can host tsdoc along with storybook

hamirmahal commented 3 years ago

Okay, sounds good. Thanks for the resources!

hamirmahal commented 3 years ago

I also recommend working on storybook integration before this so that we can figure out how we can host tsdoc along with storybook

Now that we've taken care of storybook integration with #6, should we move forward with adding typedoc support?

amilajack commented 3 years ago

Sounds like a good idea!

hamirmahal commented 3 years ago

14 addresses at least part of this. What's next?

amilajack commented 3 years ago

We should try to host the generated docs. But at the moment I'd say this is a lower priority. There's a good amount of the API that is still changing.