Investigate TypeDoc build step

politie / sherlock

A reactive programming library for JavaScript applications, built with TypeScript.

Apache License 2.0

38 stars 11 forks source link

Investigate TypeDoc build step #4

Open WouterSpaak opened 6 years ago

WouterSpaak commented 6 years ago

The source code is very well documented, but discoverability of functions, operators and classes is lacking. It seems a good idea to generate a documentation page and TypeDoc looks to be quite mature.

Is it possible to integrate TypeDoc in the build chain?

pavadeli commented 6 years ago

Sure! Go for it. @wvanderdeijl is looking into build automation, have a chat with him about integrating the docs. I'd really like to have all docs online on a GitHub page.