IxJS icon indicating copy to clipboard operation
IxJS copied to clipboard

API docs missing

Open slikts opened this issue 5 years ago • 6 comments

I'm not sure if I'm being obtuse, but where are the API docs? Even the default tsdoc output would help.

slikts avatar Oct 09 '18 17:10 slikts

I tried running the esdoc npm script after building, but that only seemed to copy sources into .html files. Running typedoc worked, however; the result can be seen here: https://slikts.github.io/IxJS/

slikts avatar Oct 09 '18 22:10 slikts

@slikts thanks, this looks great! @mattpodwysocki what do you think?

trxcllnt avatar Oct 11 '18 17:10 trxcllnt

I've actually found it simpler to directly use the source as a reference. The typedoc results might be better than nothing, but they're rather noisy and chaotic. esdoc might be better, but I'm not familiar enough with either this or it to make it work. documentation.js is nice, but it unfortunately doesn't support TS (yet?).

slikts avatar Oct 12 '18 13:10 slikts

@trxcllnt agreed! Looks great to me

mpodwysocki avatar Oct 23 '18 16:10 mpodwysocki

Isn't there API docs somewhere? I thought the main readme.md had a link to docs once upon a time? Or if not, it's pretty a common pattern to have API docs linked from the readme so that it show sup here on GitHub or npm.

ShawnTalbert avatar Apr 19 '19 13:04 ShawnTalbert

Am I missing something or has this library remained only partially documented for the last 2 years?

The link above is ok, but it would be nice if there were more complete examples of the more esoteric functions.

BrutalSimplicity avatar Jan 05 '22 07:01 BrutalSimplicity

Docs now published at https://reactivex.io/IxJS/ :tada:

trxcllnt avatar Dec 29 '23 10:12 trxcllnt