Skip to content

Commit 94aa41a

Browse files
coliffCopilot
andauthored
Update documentation with latest references and versions (#1780)
* Update documentation with latest references and versions Added 'Further reading' links to Axe rules in 'id-unique' and 'input-requires-label' docs. Updated GitHub Actions versions in code scanning usage guide. Updated embedded HTMLHint version in VS Code extension documentation from 1.7.0 to 1.8.0. * Update website/AGENTS.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent da29dd6 commit 94aa41a

File tree

5 files changed

+19
-4
lines changed

5 files changed

+19
-4
lines changed

website/AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Agents
2+
3+
<!-- https://agents.md -->
4+
5+
- The site is built with Astro Starlight.
6+
- The site is hosted on Cloudflare Pages.
7+
8+
## Rules pages
9+
10+
- For accessibility rules, add a 'Further Reading' link at the bottom to the relevant documentation and prefer MDN and Axe.
11+
- Where appropriate, add a 'Why this rule is important' section to the rule page.

website/src/content/docs/rules/id-unique.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ Level: <Badge text="Error" variant="danger" />
3030
### Why this rule is important
3131

3232
Duplicate ID attributes can cause unexpected behavior and make the code harder to read and maintain.
33+
34+
Further reading: [Axe Rules - duplicate-id](https://dequeuniversity.com/rules/axe/4.1/duplicate-id)

website/src/content/docs/rules/input-requires-label.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,5 @@ Level: <Badge text="Warning" variant="caution" />
3838
### Why this rule is important
3939

4040
This rule ensures that the input element has a corresponding label element for accessibility compliance.
41+
42+
Further reading: [Axe Rules - input elements must have labels](https://dequeuniversity.com/rules/axe/4.1/label)

website/src/content/docs/usage/github-code-scanning.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ jobs:
3434
runs-on: ubuntu-latest
3535
steps:
3636
- name: Checkout code
37-
uses: actions/checkout@v5
37+
uses: actions/checkout@v6
3838
with:
3939
persist-credentials: false
4040

4141
- name: Set up Node.js
42-
uses: actions/setup-node@v5
42+
uses: actions/setup-node@v6
4343

4444
# If you need a website build script, include the steps here
4545

@@ -48,7 +48,7 @@ jobs:
4848
# Continue even if HTMLHint finds issues
4949

5050
- name: Upload SARIF file
51-
uses: github/codeql-action/upload-sarif@v3
51+
uses: github/codeql-action/upload-sarif@v4
5252
with:
5353
sarif_file: website/htmlhint.sarif
5454
category: HTMLHint

website/src/content/docs/vs-code-extension.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components'
99

1010
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.
1111

12-
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).
12+
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).
1313

1414
## Download
1515

0 commit comments

Comments
 (0)