Skip to content

Rework template for individual Rules pages #4365

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Right now individual rules' pages have a somewhat unwieldy header based on their description. I'd like to swap that with a header equal to the rule name, and move that description into body text.

It'd be nice to also auto-generated an ESLint config snippet for enabling the rule...

Screenshot of the huge header on https://typescript-eslint.io/rules/adjacent-overload-signatures

Metadata

Metadata

Labels

accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updating

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions