diff --git a/website/AGENTS.md b/website/AGENTS.md new file mode 100644 index 000000000..973f5ffdb --- /dev/null +++ b/website/AGENTS.md @@ -0,0 +1,11 @@ +# Agents + + + +- The site is built with Astro Starlight. +- The site is hosted on Cloudflare Pages. + +## Rules pages + +- For accessibility rules, add a 'Further Reading' link at the bottom to the relevant documentation and prefer MDN and Axe. +- Where appropriate, add a 'Why this rule is important' section to the rule page. diff --git a/website/src/content/docs/rules/id-unique.mdx b/website/src/content/docs/rules/id-unique.mdx index d9a68f4bd..d0e7fb7d0 100644 --- a/website/src/content/docs/rules/id-unique.mdx +++ b/website/src/content/docs/rules/id-unique.mdx @@ -30,3 +30,5 @@ Level: ### Why this rule is important Duplicate ID attributes can cause unexpected behavior and make the code harder to read and maintain. + +Further reading: [Axe Rules - duplicate-id](https://dequeuniversity.com/rules/axe/4.1/duplicate-id) diff --git a/website/src/content/docs/rules/input-requires-label.mdx b/website/src/content/docs/rules/input-requires-label.mdx index 5303116de..c6c712cb5 100644 --- a/website/src/content/docs/rules/input-requires-label.mdx +++ b/website/src/content/docs/rules/input-requires-label.mdx @@ -38,3 +38,5 @@ Level: ### Why this rule is important This rule ensures that the input element has a corresponding label element for accessibility compliance. + +Further reading: [Axe Rules - input elements must have labels](https://dequeuniversity.com/rules/axe/4.1/label) diff --git a/website/src/content/docs/usage/github-code-scanning.mdx b/website/src/content/docs/usage/github-code-scanning.mdx index 5389a7a04..56c3185b0 100644 --- a/website/src/content/docs/usage/github-code-scanning.mdx +++ b/website/src/content/docs/usage/github-code-scanning.mdx @@ -34,12 +34,12 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v6 with: persist-credentials: false - name: Set up Node.js - uses: actions/setup-node@v5 + uses: actions/setup-node@v6 # If you need a website build script, include the steps here @@ -48,7 +48,7 @@ jobs: # Continue even if HTMLHint finds issues - name: Upload SARIF file - uses: github/codeql-action/upload-sarif@v3 + uses: github/codeql-action/upload-sarif@v4 with: sarif_file: website/htmlhint.sarif category: HTMLHint diff --git a/website/src/content/docs/vs-code-extension.mdx b/website/src/content/docs/vs-code-extension.mdx index c1a2a172a..9f9f19442 100644 --- a/website/src/content/docs/vs-code-extension.mdx +++ b/website/src/content/docs/vs-code-extension.mdx @@ -9,7 +9,7 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components' Get realtime linting feedback in Visual Studio Code with the HTMLHint extension. This extension provides a seamless integration of HTMLHint into your development workflow, allowing you to catch HTML issues as you type. -The HTMLHint extension will attempt to use the locally installed HTMLHint module (the project-specific module if present, or a globally installed HTMLHint module). If a locally installed HTMLHint isn't available, the extension will use the embedded version (current version 1.7.0). +The HTMLHint extension will attempt to use the locally installed HTMLHint module (the project-specific module if present, or a globally installed HTMLHint module). If a locally installed HTMLHint isn't available, the extension will use the embedded version (current version 1.8.0). ## Download