Docs: Document @typescript-eslint/type-utils

[JoshuaKGoldberg]

Before You File a Documentation Request Please Confirm You Have Done The Following...

• I have looked for existing open or closed documentation requests that match my proposal.
• I have read the FAQ and my problem is not listed.

Suggested Changes

https://www.npmjs.com/package/@typescript-eslint/type-utils says:

👉 See https://typescript-eslint.io/packages/type-utils for documentation on this package.

https://typescript-eslint.io/packages/type-utils is a 404.

Additionally, #8089 raises a good point: it's not clear whether @typescript-eslint/type-utils is part of our public API...

• If it is: we should document it and fill in the 404 page
• If it isn't: we should change its README.md to mention it

Affected URL(s)

https://typescript-eslint.io/packages/type-utils and/or https://www.npmjs.com/package/@typescript-eslint/type-utils

[bradzacher]

It is - we just didn't do a good job of documentation when it was created. The utils package is poorly documented as well. There's an issue for that somewhere too.

[JoshuaKGoldberg]

Adding to the v8 milestone to make sure we get to it by then. This isn't a breaking change at all, so it's fine to come in sooner.

[JoshuaKGoldberg]

There are enough functions in utils and type-utils that IMO if we want to include full docs on the website we should autogenerate the docs - not hand-write them. I found two TypeDoc plugins for Docusaurus that seem feasible:

• https://github.com/milesj/docusaurus-plugin-typedoc-api
• https://typedoc-plugin-markdown.org

Trying both out.

Edit: split out into #9298 as a followup issue.