Update documentation with latest references and versions #1780
Conversation
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.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation by adding 'Further reading' links and updating versions for GitHub Actions and the VS Code extension. While the intent is good, the updated GitHub Actions versions in the code scanning guide are incorrect and will cause user workflows to fail. I've suggested corrections to use the latest stable versions. Additionally, I've recommended using version-agnostic URLs for the Axe rules to ensure the links remain current.
There was a problem hiding this comment.
Pull request overview
This PR updates documentation with improved references and newer version numbers. The embedded HTMLHint version in VS Code extension docs is updated from 1.7.0 to 1.8.0, GitHub Actions examples are upgraded to v6/v4, and accessibility rule pages now include "Further reading" links to Axe documentation. Additionally, an AGENTS.md file is introduced to document site-specific guidelines.
- Updated embedded HTMLHint version reference in VS Code extension documentation
- Upgraded GitHub Actions version examples in code scanning guide
- Added "Further reading" links to accessibility rule documentation pages
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/src/content/docs/vs-code-extension.mdx | Updated embedded HTMLHint version from 1.7.0 to 1.8.0 |
| website/src/content/docs/usage/github-code-scanning.mdx | Updated GitHub Actions versions in usage examples (checkout v5→v6, setup-node v5→v6, codeql-action v3→v4) |
| website/src/content/docs/rules/input-requires-label.mdx | Added "Further reading" link to Axe documentation for the label rule |
| website/src/content/docs/rules/id-unique.mdx | Added "Further reading" link to Axe documentation for the duplicate-id rule |
| website/AGENTS.md | New file documenting site-building guidelines and rule documentation conventions |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Deploying htmlhint with
|
| Latest commit: |
ea36c04
|
| Status: | ⚡️ Build in progress... |
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.