Document types

[Rich-Harris]

Follow-up to #4010. The idea here is to make types linkable throughout the docs — rather than the unreadable gibberish you get from automatic doc generators, this literally just copies the source .d.ts into the docs, extracts leading JSDoc comments, and crosslinks everything.

So for example in the endpoint docs, the RequestHandler type becomes a link...

...that points here:

• Prevent type docs linking to themselves (e.g. RequestHandler -> RequestHandler in the example above)
• Improve the styles a bit
• Add more JSDoc comments explaining the various types this can happen in a follow-up
• Rethink App vs App — maybe we rename the class? follow-up in Rename App #4030
• Include types in search index
• Either remove links from lsp attributes, or have the tooltip actually link to them
• make comments work on mobile (i.e. not stretch out into the distance) somehow

[changeset-bot]

⚠️ No Changeset found

Latest commit: 98ce2ac

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[pngwn]

Can we set a max length on the snippets? Some of them are very difficult to read on mobile.

[Rich-Harris]

Do you mean running Prettier on the snippets with a shorter line length, or something?

[pngwn]

Yeah, that would be good if it is possible.

[Rich-Harris]

Made that change. The JSDoc comments will need to be updated (and maintained) manually though

[Rich-Harris]

Would be good if this linked to Adapter. At the very least the HTML shouldn't be visible: