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

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

Suggested Changes

Following#5392, most rule options will havedescriptions in their schemas. For many of those options, their docs either:

• Don't have an actual description of the option (see theallowAny example later)
• As ofdocs: fill in most remaining rule option descriptions #9868, roughly -or exactly- match what's on their docs pages

Proposal: let's have the rule docs generation also inject thedescription and default value for each rule option into its### heading?

For example, theallowAnydescription inrestrict-plus-operands:

...could be used as a first line in the docs page under its h3:

We could also mention the default value.

In other words, the end result I'm proposing is:

### `allowAny`+ Whether to allow `any` typed values.+ Default: `false`.Examples of code for this rule with `{ allowAny: true }`:

We'd have to do a pass to remove redundant lines in the.mdx files.

Affected URL(s)

https://typescript-eslint.io/rules/*

💖