caravan-bitcoin / caravan

Caravan monorepo
https://caravanmultisig.com
MIT License
37 stars 32 forks source link

Add automatic documentation generation #125

Open bucko13 opened 2 months ago

bucko13 commented 2 months ago

The typescript and jsdocs code comments will need to be improved overtime but I think some value could be added from having the generation in place. Ideally it's also added to CI so new docs are generated on merges to main.

I don't have a strong opinion on what library to use for this. It'll depend on what's most stable and used in the community but something like ts-docs or typedoc seem like good option.