docs/lychee
Checks that local documentation links reach existing files and valid anchor or text fragments.
Part of the docs configuration, at the recommended level. It runs at the commit stage, per file. It runs lychee.
A dead link inside the repository breaks silently, and readers hit it first.
What to do
Section titled “What to do”Point the link at the file or heading that exists, or delete it.
Example
Section titled “Example”The link [Setup](missing.md) reports a broken target when no missing.md exists. Point it at the setup guide, or add that file.
Turn it off
Section titled “Turn it off”Turn it off for some files, or one of its lint rules, with a reason:
gspot ignore docs/lychee --paths "<glob>" --reason "<why>"gspot ignore docs/lychee --rule <rule> --reason "<why>"