Skip to content

Automatic scanning of docs for broken links #3249

Closed
@anderseknert

Description

@anderseknert

After fixing what I found in PR #3248 I thought some more about broken links in the docs. Broken links are annoying and gives a bad (potentially first) impression of our docs. We should try to automate the process of finding these and reporting them as soon as discovered.

Just running one of the many tools that show up on a search for such a tool provides an overview of links currently found to be broken. I have no idea about the accuracy of this but it provides at least a pointer. Perhaps someone has experience and could recommend a tool that scans for broken links and integrates nicely with Github Actions, and we could run these scans in a scheduled job every week or so.

Screenshot 2021-03-10 at 23 32 04

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions