tech-docs-template
tech-docs-template copied to clipboard
Add linter to check for dead links?
We're using this template for our technical documentation in GOV.UK Verify. One of the things we've found is that we slowly accumulated dead internal links due to content getting moved around.
To fix this, we've added a linter to catch new internal dead links, using html-proofer. It means that our docs will now not build if we introduce a new internal dead link.
Might this be something that would be useful to contribute upstream to the template?
It sounds extremely useful
OK. I've raised https://github.com/alphagov/tech-docs-template/pull/187 to implement.