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

Generate documentation from types #920

Closed
szmarczak opened this issue Nov 5, 2019 · 6 comments
Closed

Generate documentation from types #920

szmarczak opened this issue Nov 5, 2019 · 6 comments
Labels
documentation The issue will improve the docs enhancement This change will extend Got features ✭ help wanted ✭

Comments

@szmarczak
Copy link
Collaborator

szmarczak commented Nov 5, 2019

https://github.com/TypeStrong/typedoc

It'd be best to generate Markdown, but it can be JSON too. We can generate Markdown later.

@szmarczak szmarczak added enhancement This change will extend Got features ✭ help wanted ✭ documentation The issue will improve the docs labels Nov 5, 2019
@sindresorhus
Copy link
Owner

sindresorhus commented Nov 6, 2019

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.

@szmarczak
Copy link
Collaborator Author

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.

@szmarczak
Copy link
Collaborator Author

I mean we could code the look of the docs.

@sindresorhus
Copy link
Owner

sindresorhus commented Nov 7, 2019

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.

@szmarczak
Copy link
Collaborator Author

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 deno doc generator. typedoc is still missing lots of things (131 issues as of 24/09/2020):

@szmarczak
Copy link
Collaborator Author

Closing as we cannot do anything about this right now. The documentation has been updated and is more clear than Got 11.

Repository owner deleted a comment from UltiRequiem Mar 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue will improve the docs enhancement This change will extend Got features ✭ help wanted ✭
Projects
None yet
Development

No branches or pull requests

2 participants