Generating docs from tsdoc

[Amareis]

Documentation Is:

• Missing
• Needed
• Confusing
• Not Sure?

Please Explain in Detail...

At least two latest PR's #3841 #3660 contains fixes for some documentation mismatch with actual code behaviour. Maybe we should moved some part of documentation in code? At least everything from types.d.ts can be generated from tsdoc - and it will be great since IDE can use it during the development, and user can just navigated through it even without actual docs.
https://github.com/microsoft/tsdoc

Your Proposal for Changes

Move functions, types and hooks docs to TSDoc and generate markdown from it. This should not be really hard, but need some amount of mechanical work. Additionally, there is can be possibility to use some universal cross-links, which will works in both github markdown and on site (but it additional feature, I think).

[lukastaegert]

That would definitely be possible, but I must admit I do not have capacity for this. If someone would create a prototype that implements this for a few example types, then we can certainly talk about this. The website repo also does some basic transformations during parsing of the markdown files, it could definitely also extract some of its information from the code.