Docusaurus adds anh1 automatically if the file doesn't already start with one. So all we need to add is the description.

1. Maybe use a paragraph instead of a quote?
2. Add this to theRuleAttributes component instead of in Markdown? Thedescription is already part of the rule metadata available on client side.

I like it as a quote though 😄: it adds subtle differentiation and matches the ESLint docs.

ForRuleAttributes, that shows up after any existing initial paragraph 😕 so it would be out of order:

@armano2 starting a thread for#5249 (comment):

I think the idea is that the docs should not be viewed on GitHub but should be as maintainable as possible.

if that is a case than we should move it out of eslint-plugin to docs

I think I agree, it would be best long term to have these docs files in the docs area. But: the old .md files still have much better SEO than the site. We can't move them all-up just yet. The most we could do would be to leave a .md file in the old location with just the redirect notice.

What would you prefer I do in this PR? I don't have strong feelings one way or another, as long as we're moving towards automating more of the rule docs pages.

Personally - I think it's still a good idea to co-locate them with the plugin - that way they're easy to find and update for contributors.

I am 100% behind treating the .md files in the repo as source code for most things (i.e. users shouldn't read them).
It's what I said a year ago with the first versions of the website!

Also LMAO I had a different opinion back then about where to put the files:

TBH - I also don't see any tangible value in co-locating the docs with the packages.

So I'll say - I don't mind either way. As long as we keep things clearly documented for contributors (i.e. tests to fail if they've not been added, or not been deleted) - then it shouldn't matter.