Skip to content

Commit a012b69

Browse files
johnemauantross
andauthored
Docs: Fix broken hint-axe README.md links
hint-axe docs are now generated at build time so the relative path is only good for post build local install of the repository and results in 404s for anyone browsing github or npmjs.org (the more common scenario). To give the best experience for the more common scenario this change directs the links to webhint.io which will have the information from the latest release. - - - - - - - - - - - - - - - - - - - - Ref #3937 Fix #3792 Close #3967 Co-authored-by: Tony Ross <[email protected]>
1 parent 4f714a5 commit a012b69

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

packages/hint-axe/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -175,18 +175,18 @@ your project.
175175
[wai]: https://www.w3.org/WAI/intro/accessibility.php
176176
[wcag 2.1]: https://www.w3.org/TR/WCAG21/
177177
<!-- start hint links -->
178-
[axe/aria]: ./docs/aria.md
179-
[axe/color]: ./docs/color.md
180-
[axe/forms]: ./docs/forms.md
181-
[axe/keyboard]: ./docs/keyboard.md
182-
[axe/language]: ./docs/language.md
183-
[axe/name-role-value]: ./docs/name-role-value.md
184-
[axe/other]: ./docs/other.md
185-
[axe/parsing]: ./docs/parsing.md
186-
[axe/semantics]: ./docs/semantics.md
187-
[axe/sensory-and-visual-cues]: ./docs/sensory-and-visual-cues.md
188-
[axe/structure]: ./docs/structure.md
189-
[axe/tables]: ./docs/tables.md
190-
[axe/text-alternatives]: ./docs/text-alternatives.md
191-
[axe/time-and-media]: ./docs/time-and-media.md
178+
[axe/aria]: https://webhint.io/docs/user-guide/hints/hint-axe/aria/
179+
[axe/color]: https://webhint.io/docs/user-guide/hints/hint-axe/color/
180+
[axe/forms]: https://webhint.io/docs/user-guide/hints/hint-axe/forms/
181+
[axe/keyboard]: https://webhint.io/docs/user-guide/hints/hint-axe/keyboard/
182+
[axe/language]: https://webhint.io/docs/user-guide/hints/hint-axe/language/
183+
[axe/name-role-value]: https://webhint.io/docs/user-guide/hints/hint-axe/name-role-value/
184+
[axe/other]: https://webhint.io/docs/user-guide/hints/hint-axe/other/
185+
[axe/parsing]: https://webhint.io/docs/user-guide/hints/hint-axe/parsing/
186+
[axe/semantics]: https://webhint.io/docs/user-guide/hints/hint-axe/semantics/
187+
[axe/sensory-and-visual-cues]: https://webhint.io/docs/user-guide/hints/hint-axe/sensory-and-visual-cues/
188+
[axe/structure]: https://webhint.io/docs/user-guide/hints/hint-axe/structure/
189+
[axe/tables]: https://webhint.io/docs/user-guide/hints/hint-axe/tables/
190+
[axe/text-alternatives]: https://webhint.io/docs/user-guide/hints/hint-axe/text-alternatives/
191+
[axe/time-and-media]: https://webhint.io/docs/user-guide/hints/hint-axe/time-and-media/
192192
<!-- end hint links -->

packages/hint-axe/scripts/create/create-docs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ const updateReadme = async (categories) => {
7878
const hintLinks = categories.map((category) => {
7979
const id = categoryId(category);
8080

81-
return `[axe/${id}]: ./docs/${id}.md`;
81+
return `[axe/${id}]: https://webhint.io/docs/user-guide/hints/hint-axe/${id}/`;
8282
});
8383

8484
const content = source

0 commit comments

Comments
 (0)