Description
This should be tested when building the HTML, but apparently it only tests links internal to all.html
page:
Lines 85 to 88 in 9d12c14
Usually that would cover all links internal to the docs, as all links to doc pages are stripped from the filename to keep only the hash part:
Lines 39 to 45 in 9d12c14
But in this case, because modules_module.html
doesn't exist, it's treated as an external page and the broken links slip through the test…
I haven't dug into why but it looks like the api docs are deliberately excluded
Yes indeed. The reason checkLinks.js
does not cover api
is because we are using .html
extension to reference other doc pages, while checkLinks.js
would expect .md
. One way of fixing it would be to use .md
extensions in the Markdown files, and use checkLinks.js
to test said links – it would also improve the experience of navigating the docs through GitHub web UI. Another way would be to tweak the current test to make sure this doesn't reproduce.
Originally posted by @aduh95 in #35182 (comment)