# docs

> Documentation links that reach their files, anchors, and sites, and documented paths and commands that exist. Level `all` requires a README in every scope and a LICENSE at the root.

Documentation links that reach their files, anchors, and sites, and documented paths and commands that exist. Level `all` requires a README in every scope and a LICENSE at the root.

## Checks

| Check                                                             | Stage    | Level         | What it does                                                                                                                                      |
| ----------------------------------------------------------------- | -------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`docs/lychee`](/reference/checks/docs/lychee/)                   | `commit` | `recommended` | Checks that local documentation links reach existing files and valid anchor or text fragments.                                                    |
| [`docs/lychee-external`](/reference/checks/docs/lychee-external/) | `manual` | `recommended` | Checks every external link over the network.                                                                                                      |
| [`docs/missing-paths`](/reference/checks/docs/missing-paths/)     | `commit` | `recommended` | Checks that documented paths point to tracked files, and that mise, npm, pnpm, yarn, and bun run commands name a task or script of their project. |
| [`docs/required-files`](/reference/checks/docs/required-files/)   | `commit` | `all`         | Checks that every scope has a README.md and the root has a LICENSE.                                                                               |

## Settings

| Setting                                                               | What it sets                                                      |
| --------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [`docs.banned_headings`](/reference/gspot-toml/#docs.banned_headings) | Headings this repository bans beyond the shipped list.            |
| [`docs.allowed_urls`](/reference/gspot-toml/#docs.allowed_urls)       | Allowed URL patterns; additions need a reason for the whole list. |

## Selected when

Always selected.

## Rules for coding agents

| Rule file                                          | Installed when |
| -------------------------------------------------- | -------------- |
| `.gspot/configurations/general/docs/rules/DOCS.md` | Always         |

## Tools and versions

| Tool   | Version  |
| ------ | -------- |
| lychee | `0.24.2` |

## Files gspot writes

gspot writes `.gspot/configurations/general/docs/lychee.toml`.