Generated TypeDoc

[benmccann]

Describe the problem

It's hard to keep the docs in sync with the types and our current method of displaying them isn't always the most readable

Describe the proposed solution

I took a stab at playing around with this. There are two approaches I tried:

• https://github.com/sveltejs/kit/tree/typedoc-markdown
• https://github.com/sveltejs/kit/tree/typedoc-json

At first I tried having it spit out .md files. That was a bit tricky because they don't quite match the format expected with what we've hand-written. E.g. it includes # and ## whereas our parser expects headings to start only at ###

Rich suggested a better approach might be to generate JSON instead and work from that. That turned out to be the more fruitful and customizable approach I think

Alternatives considered

Copy .d.ts files into docs still

Importance

nice to have

Additional Information

No response

[benmccann]

Closing in favor of #4002