Description
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
We refer to typed linting a lot in our docs, but most of the time it's either quick high-level references or deep technical dives. We never actually state "this is what typed linting is, and here's why you should enable it". I think that's a part of why many users don't use it, then eventually migrate to Biome/Oxlint/etc.
The main user flow users take for it is roughly:
- Start on the homepage / docs
- Go through the quickstart on https://typescript-eslint.io/getting-started/
- Maybe go to Next Steps > Typed Linting, which links to ...
- https://typescript-eslint.io/getting-started/typed-linting: which only mentions the following two sentences:
Some typescript-eslint rules utilize the awesome power of TypeScript's type checking APIs to provide much deeper insights into your code. To tap into TypeScript's additional powers, there are two small changes you need to make to your config file:
I think we can do better than this by adding:
- A blog post explaining what it is and why it's useful, including some of the most impactful rules (e.g. no-floating-promises)
- A more impactful summary of that blog post in the typed linting page, with a link to the blog post
Affected URL(s)
https://typescript-eslint.io/getting-started/typed-linting
https://typescript-eslint.io/blog/typed-linting
Additional Info
This was in part inspired by @ElianCodes walking me through a docs audit (https://www.youtube.com/watch?v=Vyu8FU0VAqA&t=110s). Therefore:
Co-authored-by: @ElianCodes