# docs/lychee

> Checks that local documentation links reach existing files and valid anchor or text fragments.

Checks that local documentation links reach existing files and valid anchor or text fragments.

Part of the [`docs`](/reference/configurations/docs/) configuration, at the `recommended` [level](/start/concepts/#levels). It runs at the `commit` [stage](/start/concepts/#stage), per file. It runs lychee.

## Why

A dead link inside the repository breaks silently, and readers hit it first.

## What to do

Point the link at the file or heading that exists, or delete it.

## 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

Turn it off for some files, or one of its lint rules, with a reason:

```shell
gspot ignore docs/lychee --paths "<glob>" --reason "<why>"
gspot ignore docs/lychee --rule <rule> --reason "<why>"
```