Improve generated documentation
Closed this issue · 2 comments
joshfarrant commented
The generated docs currently just about do the job, but they're far from perfect.
It would be nice to have the docs generated from the Typescript types, rather than having to markup the code with jsdoc comments, which often just duplicate the information given in the typings. I'd be interested to see how other Typescript libraries handle generated documentation.
Also, the current theme being used on Shortcuts.fun isn't great, it would be worth looking into alternatives.
Any input on either of these points would be appreciated.
joshfarrant commented
This is currently in progress, I'm looking at TypeDoc as a possible solution.
joshfarrant commented
Closing this for now, as 0fc1f7f has improved things greatly.