Right now packages have their own hand-written descriptions in their README.md files. in#5984 those are moved to mdx files to be shown on typescript-eslint.io. But they're still hand-written.

From@bradzacher's#5984 (comment):

Really we would want to use something likehttps://api-extractor.com/ to do some form of generation so that people have an in-depth reference of what's included.

Also some examples of how to use some things or why to use some things.

For example - people might not know why you'd use the TSESLint export from the package (it's because @types/eslint is built on top of the base @types/estree types which don't include our AST nodes).

Let's build off#5984's changes to add ... something! Investigation required.