Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs missing #240

Closed
slikts opened this issue Oct 9, 2018 · 7 comments · Fixed by #360
Closed

API docs missing #240

slikts opened this issue Oct 9, 2018 · 7 comments · Fixed by #360

Comments

@slikts
Copy link

slikts commented Oct 9, 2018

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

@slikts
Copy link
Author

slikts commented Oct 9, 2018

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/

@trxcllnt
Copy link
Member

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

@slikts
Copy link
Author

slikts commented Oct 12, 2018

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?).

@mpodwysocki
Copy link
Contributor

@trxcllnt agreed! Looks great to me

@ShawnTalbert
Copy link

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.

@BrutalSimplicity
Copy link

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.

@trxcllnt
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants