Linkcheck

Github Readme: https://github.com/filiph/linkcheck?tab=readme-ov-file#readme 

Introduction

Linkcheck is a tool for checking the validity of links in the project. It is used to ensure that all links in the documentation are valid and do not lead to 404 errors or other issues.

Usage

We use Linkcheck to validate the links in the documentation, since there are a lot of cross-references and internal links. If a link is broken or incorrect, Linkcheck will detect it.

To run Linkcheck, check the docker usage in the linkcheck documentation 

Security

Linkcheck needs to bypass login to access the documentation, so for now, run it locally and temporarily disable auth until a better solution is developed.

Best Practice

When you move a page, make sure to update all links to that page in the documentation and run a linkcheck scan to verify.