docs: Add 'Why this rule is important' sections to rule docs #1723
Conversation
Added explanations to multiple rule documentation files describing the importance of each rule for accessibility, SEO, and code quality. Also updated the configuration example to include the new 'form-method-require' rule and fixed changelog issue links.
coliff
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds "Why this rule is important" sections to multiple rule documentation files to better explain the significance of each HTMLHint rule for accessibility, SEO, and code quality. Additionally, it includes configuration updates and fixes changelog issue links.
- Added explanatory sections to 13 rule documentation files describing the importance of each rule
- Updated the configuration example to include the new 'form-method-require' rule
- Fixed incorrect GitHub issue links in the changelog
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/src/content/docs/rules/*.mdx | Added "Why this rule is important" sections to explain rule benefits for accessibility, SEO, and code quality |
| website/src/content/docs/configuration.md | Updated configuration example to include the new 'form-method-require' rule |
| website/src/content/docs/changelog.mdx | Fixed incorrect GitHub issue links for version 1.7.0 entries |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Deploying htmlhint with
|
| Latest commit: |
2684761
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://53671a7c.htmlhint.pages.dev |
| Branch Preview URL: | https://dev-coliff-v170-docs-update.htmlhint.pages.dev |
![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 adds 'Why this rule is important' sections to many of the rule documentation files, which is a great improvement for users. It also updates the changelog and configuration file. My review focuses on a couple of issues in the changelog and a small improvement for one of the new documentation sections. Overall, great work on improving the documentation!
Added explanations to multiple rule documentation files describing the importance of each rule for accessibility, SEO, and code quality. Also updated the configuration example to include the new 'form-method-require' rule and fixed changelog issue links.