Docs: TSDoc
karnthis opened this issue · comments
With the move to TS, I would like to start including JSDoc/TSDoc comments in the code for each function. This can then be generated in-project and hosted by GitHub pages to allow for easy review without needing to dig in the codebase.
Thoughts?
Slightly lower priority for this - but I want to add it, then have something like storybook convert it into a static website that we can use for the documentation - open to suggestions on the exact path, but making sure that the majority of the documentation is part of the code, and that there are examples of each compression algorithm is good!
For the day job I use typedoc and am quite happy with it. I can get that up and running if you like, and start filling in docs as I work on stuff. Not really focusing on it, but not putting it off til later either. An example (ours) of the generated docs can be found here if you are curious what the result looks like: https://jackallabs.github.io/jackal.js/
I have used it too - but do typedoc formatted comments everywhere - the reason I'd like something like Storybook is specifically for the demo / example that can be seen - and that's secondary to documentation, so go for it!