fix(website): add explicit frontmatter description to rule docs

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes Docs: Rule page links previews show the 🛑 warning #5425
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Per #5425 (comment), adds a frontmatter description: ... to each rule equal to its meta.docs.description.

To test, copy a link like https://deploy-preview-5429--typescript-eslint.netlify.app/rules/adjacent-overload-signatures into a DM with yourself on Slack.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 144b33f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 47 targets

• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 12 - nx test @typescript-eslint/eslint-plugin --coverage=false
• nx run-many --target=build --all --parallel --exclude website
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 12 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/utils --coverage=false
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 12 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/type-utils --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 12 - nx test @typescript-eslint/parser --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	144b33f
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/62efdccd37d70400095acc3f
😎 Deploy Preview	https://deploy-preview-5429--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[JamesHenry]

Awesome! Thanks for the quick fix, I'll approve as soon as it is no longer in draft

[Josh-Cena]

LGTM as well. Adds a bit of maintenance burden in the future (since the Jest tests are gone now) but I don't think a better solution exists with Docusaurus—unless you want to dynamically modify the Markdown files as a pre-build step! (Which sounds fine to me)

[codecov]

Codecov Report

Merging #5429 (4b95096) into main (e03826f) will increase coverage by 2.46%.
The diff coverage is n/a.

❗ Current head 4b95096 differs from pull request most recent head 144b33f. Consider uploading reports for the commit 144b33f to get more accurate results

@@            Coverage Diff             @@
##             main    #5429      +/-   ##
==========================================
+ Coverage   91.36%   93.83%   +2.46%     
==========================================
  Files         132      290     +158     
  Lines        1494     9985    +8491     
  Branches      226     3005    +2779     
==========================================
+ Hits         1365     9369    +8004     
- Misses         65      335     +270     
- Partials       64      281     +217     

Flag	Coverage Δ
unittest	93.83% <ø> (+2.46%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...slint-plugin/src/rules/no-unnecessary-qualifier.ts	100.00% <0.00%> (ø)
packages/eslint-plugin/src/rules/no-namespace.ts	100.00% <0.00%> (ø)
.../eslint-plugin/src/rules/promise-function-async.ts	98.03% <0.00%> (ø)
...lugin/src/rules/no-confusing-non-null-assertion.ts	82.60% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-invalid-this.ts	80.00% <0.00%> (ø)
packages/eslint-plugin/src/rules/comma-dangle.ts	93.33% <0.00%> (ø)
...s/eslint-plugin/src/util/collectUnusedVariables.ts	93.19% <0.00%> (ø)
packages/eslint-plugin/src/rules/await-thenable.ts	100.00% <0.00%> (ø)
...rc/rules/no-unnecessary-boolean-literal-compare.ts	90.36% <0.00%> (ø)
...es/eslint-plugin/src/util/isUndefinedIdentifier.ts	100.00% <0.00%> (ø)
... and 148 more

[JamesHenry]

🎉