Update docs and config for rules and keywords - #1738
Conversation
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.
![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 primarily focuses on improving the documentation by adding keywords for better searchability, clarifying rule configurations and incompatibilities, and enhancing explanations. My review identified a potential rendering issue in one of the documentation files due to a likely typo in the markdown syntax, and also suggests a wording improvement in another file to enhance clarity and professionalism. Overall, these are positive changes that improve the project's documentation.
| Lowercase tagnames typically have higher compression rates compared to uppercase tagnames allowing for slightly faster page loads. | ||
| Lowercase tagnames are also more readable and easier to understand. |
There was a problem hiding this comment.
The explanation for this rule's importance could be phrased more clearly and professionally. The current version has a minor grammatical awkwardness and could better articulate the benefits.
Lowercase tagnames typically have higher compression rates compared to uppercase tagnames, leading to slightly faster page loads.
Lowercase tagnames are also more readable and align with common coding conventions.
Added guidelines for documentation language and referencing authoritative sources in general.mdc. Removed a trailing newline from attr-value-single-quotes.mdx.
Deploying htmlhint with
|
| Latest commit: |
6f6ff23
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://515e6281.htmlhint.pages.dev |
| Branch Preview URL: | https://dev-coliff-minor--docs--upda.htmlhint.pages.dev |
1 participant
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.