-
-
Notifications
You must be signed in to change notification settings - Fork 935
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
Generate documentation from types #920
Comments
I’m not a big fan of Typedoc. The docs UI/structure it creates is not very user friendly and the generator itself is missing support for lots of TS features and it’s quite buggy. There’s unfortunately no other docs generator for TS. |
Is there something that just reads comments? E.g. if we know what we are documenting, what arguments does it take, what's its description, we can generate markdown on our own. |
I mean we could code the look of the docs. |
I mean, we could still use it in addition to human written notes, but it's not good enough to replace our handwritten docs. But at minimum, #758 should be fixed first, and we need a lot more doc comments. |
Since #758 is now fixed, I think we can start looking deeper into this issue. Deno has pretty nice docs IMO: https://doc.deno.land/https/deno.land/std/http/server.ts But it has its own |
Closing as we cannot do anything about this right now. The documentation has been updated and is more clear than Got 11. |
https://github.com/TypeStrong/typedoc
It'd be best to generate Markdown, but it can be JSON too. We can generate Markdown later.
The text was updated successfully, but these errors were encountered: