Update docs and config for rules and keywords (#1738)

* Update docs and config for rules and keywords

Added keywords for accessibility and SEO to several rule docs, clarified rule incompatibility with Prettier, and improved explanations for tagname rules. Updated configuration example for clarity and bumped embedded HTMLHint version in VS Code extension docs. Minor spelling update in cspell config and commit message instructions.

* Update documentation rules and fix trailing newline

Added guidelines for documentation language and referencing authoritative sources in general.mdc. Removed a trailing newline from attr-value-single-quotes.mdx.

Author: coliff

.cspell.json

@@ -59,6 +59,7 @@
     "nomix",
     "noopener",
     "npmjs",
+    "onclick",
     "onttt",
     "opencollective",
     "ossf",

.cursor/rules/general.mdc

@@ -16,3 +16,8 @@ alwaysApply: true
 - The workflows should be named `<workflow-name>.yml`.
 - All GitHub Actions should be pinned versions to avoid breaking changes (SHA-1).
 - If using actions/checkout, it should have `persist-credentials: false` set.
+
+## Documentation
+
+- All documentation should be written in US English.
+- For the 'Why this rule is important' section, always include a link to the relevant documentation and prefer MDN and Google documentation along with official documentation from the W3C.

.github/copilot-instructions.md

@@ -26,3 +26,7 @@
 - The workflows should be named `<workflow-name>.yml`.
 - All GitHub Actions should be pinned versions to avoid breaking changes (SHA-1).
 - If using actions/checkout, it should have `persist-credentials: false` set.
+
+## GitHub Commit Messages
+
+- If multiple changes are made then list changes using bullet points.

website/src/content/docs/configuration.md

@@ -39,52 +39,50 @@ An example configuration file (with all rules disabled):
 
 ```json
 {
-  "rules": {
-    "alt-require": false,
-    "attr-lowercase": false,
-    "attr-no-duplication": false,
-    "attr-no-unnecessary-whitespace": false,
-    "attr-sorted": false,
-    "attr-unsafe-chars": false,
-    "attr-value-double-quotes": false,
-    "attr-value-no-duplication": false,
-    "attr-value-not-empty": false,
-    "attr-value-single-quotes": false,
-    "attr-whitespace": false,
-    "button-type-require": false,
-    "doctype-first": false,
-    "doctype-html5": false,
-    "empty-tag-not-self-closed": false,
-    "form-method-require": false,
-    "frame-title-require": false,
-    "h1-require": false,
-    "head-script-disabled": false,
-    "href-abs-or-rel": false,
-    "html-lang-require": false,
-    "id-class-ad-disabled": false,
-    "id-class-value": false,
-    "id-unique": false,
-    "inline-script-disabled": false,
-    "inline-style-disabled": false,
-    "input-requires-label": false,
-    "link-rel-canonical-require": false,
-    "main-require": false,
-    "meta-charset-require": false,
-    "meta-description-require": false,
-    "meta-viewport-require": false,
-    "script-disabled": false,
-    "space-tab-mixed-disabled": false,
-    "spec-char-escape": false,
-    "src-not-empty": false,
-    "style-disabled": false,
-    "tag-no-obsolete": false,
-    "tag-pair": false,
-    "tag-self-close": false,
-    "tagname-lowercase": false,
-    "tagname-specialchars": false,
-    "tags-check": false,
-    "title-require": false
-  }
+  "alt-require": false,
+  "attr-lowercase": false,
+  "attr-no-duplication": false,
+  "attr-no-unnecessary-whitespace": false,
+  "attr-sorted": false,
+  "attr-unsafe-chars": false,
+  "attr-value-double-quotes": false,
+  "attr-value-no-duplication": false,
+  "attr-value-not-empty": false,
+  "attr-value-single-quotes": false,
+  "attr-whitespace": false,
+  "button-type-require": false,
+  "doctype-first": false,
+  "doctype-html5": false,
+  "empty-tag-not-self-closed": false,
+  "form-method-require": false,
+  "frame-title-require": false,
+  "h1-require": false,
+  "head-script-disabled": false,
+  "href-abs-or-rel": false,
+  "html-lang-require": false,
+  "id-class-ad-disabled": false,
+  "id-class-value": false,
+  "id-unique": false,
+  "inline-script-disabled": false,
+  "inline-style-disabled": false,
+  "input-requires-label": false,
+  "link-rel-canonical-require": false,
+  "main-require": false,
+  "meta-charset-require": false,
+  "meta-description-require": false,
+  "meta-viewport-require": false,
+  "script-disabled": false,
+  "space-tab-mixed-disabled": false,
+  "spec-char-escape": false,
+  "src-not-empty": false,
+  "style-disabled": false,
+  "tag-no-obsolete": false,
+  "tag-pair": false,
+  "tag-self-close": false,
+  "tagname-lowercase": false,
+  "tagname-specialchars": false,
+  "tags-check": false,
+  "title-require": false
 }
 ```
 

website/src/content/docs/rules/empty-tag-not-self-closed.mdx

@@ -26,3 +26,7 @@ Level: <Badge text="Warning" variant="caution" />
 ```html
 <br />
 ```
+
+:::note
+This rule is incompatible with Prettier. If you use Prettier, you should disable this rule.
+:::

website/src/content/docs/rules/frame-title-require.mdx

@@ -4,6 +4,8 @@ title: frame-title-require
 description: Requires that frame and iframe elements have an accessible name for screen readers and assistive technologies.
 sidebar:
   badge: New
+keywords:
+  - accessibility
 ---
 
 import { Badge } from '@astrojs/starlight/components';

website/src/content/docs/rules/h1-require.mdx

@@ -2,6 +2,8 @@
 id: h1-require
 title: h1-require
 description: Ensures that an HTML document contains at least one `<h1>` element for proper document structure and accessibility.
+keywords:
+  - accessibility
 ---
 
 import { Badge } from '@astrojs/starlight/components';

website/src/content/docs/rules/html-lang-require.mdx

@@ -4,6 +4,8 @@ title: html-lang-require
 description: Requires the lang attribute on the <html> element to ensure proper language declaration for accessibility and SEO.
 keywords:
   - i18n
+  - accessibility
+  - SEO
 ---
 
 import { Badge } from '@astrojs/starlight/components';

website/src/content/docs/rules/main-require.mdx

@@ -2,6 +2,8 @@
 id: main-require
 title: main-require
 description: Ensures that an HTML document contains a `<main>` element within the `<body>` tag for proper document structure and accessibility.
+keywords:
+  - accessibility
 ---
 
 import { Badge } from '@astrojs/starlight/components';

website/src/content/docs/rules/meta-description-require.mdx

@@ -4,6 +4,9 @@ title: meta-description-require
 description: Ensures every HTML document includes a non-blank meta description tag within the head element for better SEO.
 sidebar:
   badge: New
+keywords:
+  - accessibility
+  - SEO
 ---
 
 import { Badge } from '@astrojs/starlight/components';