Got: Generate documentation from types

[szmarczak]

https://github.com/TypeStrong/typedoc

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

[sindresorhus]

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]

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]

I mean we could code the look of the docs.

[sindresorhus]

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]

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):

• https://github.com/TypeStrong/typedoc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
• https://github.com/TypeStrong/typedoc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aenhancement