search

hldb / welo

peer-to-peer, collaborative states using Merkle-CRDTs
Other
32 stars 2 forks source link

Automated API docs #34

Closed tabcat closed 1 year ago

tabcat commented 1 year ago

Add a script to automatically build API documentation.

tabcat commented 1 year ago

Have been looking at TypeDoc and api-documenter. I prefer Microsoft's api-documenter to typedoc as the markdown output looks much nicer. It's part of a larger tool named api-extractor which looks interesting and might be useful for automatic versioning in the future.

tabcat commented 1 year ago

Right now I have api-documenter spitting out a bunch of separate files for each piece I want documented (Opal, Database, Manifest, Address) but am looking to combine a few of them so they look nice in the /docs folder.