Writing API docs by hand is a pain. We should look into tools that could at least generate the TS parts and make them browsable, and let us add more hand-written material on top of that.

Some examples of possible tools I've seen:

• https://www.jsdocs.io/package/@reduxjs/toolkit/v/1.5.1
• https://api-extractor.com/pages/setup/generating_docs/
• https://github.com/lillallol/ts-doc-gen-md
• https://github.com/galvez/typejuice
• https://www.npmjs.com/package/@tremho/doc-holiday
• https://github.com/peterpeterparker/tsdoc-markdown

I do note that when I use that jsdocs tool to view RTK 1.6.0-alpha.2, it doesn't show any of the info from the nested entry points.

Ideally, I'd want something I could embed in a Markdown/MDX file, like <TSApiRef typeName="createAction" />.

I know Lenz's remark-typescript-tools lets us do something a little bit like that in terms of importing docblock content, but what I'm really looking for here is a nicely formatted view of the TS types and API definitions themselves so we don't have to write those by hand.

Other links:

• https://twitter.com/rauschma/status/1417515875465367554