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.

Sign up for GitHub

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

Jump to bottom

Research ways to create some API Documentation #223

Closed
JCMais opened this issue May 14, 2020 · 2 comments
Closed

Research ways to create some API Documentation #223

JCMais opened this issue May 14, 2020 · 2 comments
Assignees
@JCMais
Labels
documentation
Milestone
v2.1.2

Comments

@JCMais
Copy link
Owner

JCMais commented May 14, 2020 •
edited
Loading

While the codebase being written in TypeScript and having types for almost all public methods helps during library usage, it would be helpful to have online documentation available somewhere, probably with github pages.

Months ago I tried to generate one using @microsoft/api-documenter and @microsoft/api-extractor, but didn't have success. Most of the issues are somewhat related to this: microsoft/rushstack#1308

https://github.com/TypeStrong/typedoc also looks interesting
@JCMais JCMais added this to the v2.1.2 milestone May 28, 2020
@JCMais
Copy link
Owner Author

JCMais commented May 28, 2020

typedoc seems to work great, working on some documentation now. 🎉

@JCMais JCMais self-assigned this May 28, 2020
@JCMais
Copy link
Owner Author

JCMais commented May 28, 2020

http://jcmais.github.io/node-libcurl/modules/_index_.html

We now have API docs 🥳

@JCMais JCMais closed this as completed May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JCMais JCMais

Labels
documentation
Projects
None yet
Milestone
v2.1.2
Development

No branches or pull requests
1 participant
@JCMais