Document list of rules by what-they-do groups

[jeddy3]

Which issue, if any, is this issue related to?

Ref: #6376 (comment)

Is there anything in the PR that needs further explanation?

This pull request groups our list of rules by what they do rather than what they're applied to.

I believe this approach helps our users more easily:

• understand what the built-in rules do
• find related built-in rules

You can view the page here.

I think it does a better job of communicating the number of powerful rules we have for enforcing non-stylistic conventions that are unique to Stylelint.

This change also surfaced a lot of inconsistencies in our rule descriptions, which I've fixed in this pull request.

Grouping by the thing the rule applies to was mostly redundant as the rule name starts with it. I've still used those sub groups for the larger no-* and *-list group for readability, though. And I kept the old system for the stylistic rules as they'll be removed at some point.

The list of rules page now leads with just enough information for users to understand what they're looking at, i.e.:

• what makes a Stylelint rule
• and how it's named

I've moved other information that lived on the "About rules" page to the "Working on rules" page in the developer guide, which feel like a better home for it as it's more useful for people writing rules than using them.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 911adb1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[ybiquitous]

@jeddy3 Thank you for the significant improvements! 👏🏼

I've left comments to suggest fixing trivial mistakes, but any comments don't block this PR. Please feel free to address or reject them.

[ybiquitous]

Note: Perhaps, we may need to update meta.url in all rules later like this if rule URLs are changed in stylelint.io:

stylelint/lib/rules/alpha-value-notation/index.js

Lines 21 to 22 in 6599729

	const meta = {
	url: 'https://stylelint.io/user-guide/rules/list/alpha-value-notation',

- url: 'https://stylelint.io/user-guide/rules/list/alpha-value-notation',
+ url: 'https://stylelint.io/user-guide/rules/alpha-value-notation',

But then, because redirecting also will be added, it seems we can do it after publishing the new documents.

[jeddy3]

@ybiquitous Thanks for all the suggestions.

Latest version.

Note: Perhaps, we may need to update meta.url in all rules later

Done also. The URL is nicer without list.

Prepped the stylelint.io repo: stylelint/stylelint.io#285

[ybiquitous]

Thank you! LGTM 👍🏼