devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

Broken link checking should not rely on readers

Open timhunt opened this issue 3 years ago • 2 comments

What is the URL of the page where you experience the error?

Potentially all

What is the issue with this page?

Since the new docs are build by an automatic process, it should not be left to readers to find broken links like #186. The build system should find them. (Surely this is a standard feature of whatever package we are using?)

Are you able to provide a patch for this?

No response

timhunt avatar Jun 07 '22 11:06 timhunt

Hi Tim,

We do have broken link checking, but it does not currently check anchors. I will raise a request in Docusaurus for this.

andrewnicols avatar Jun 07 '22 11:06 andrewnicols

Raised upstream at https://docusaurus.io/feature-requests/p/broken-link-detection-should-check-anchors

This is actually non-trivial to implement but I'll have a think about how to do so.

andrewnicols avatar Jun 07 '22 12:06 andrewnicols