Skip to content
gspotDocs

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.

Checks

Section titled “Checks”
Check Stage Level What it does
docs/lychee commit recommended Checks that local documentation links reach existing files and valid anchor or text fragments.
docs/lychee-external manual recommended Checks every external link over the network.
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 commit all Checks that every scope has a README.md and the root has a LICENSE.

Settings

Section titled “Settings”
Setting What it sets
docs.banned_headings Headings this repository bans beyond the shipped list.
docs.allowed_urls Allowed URL patterns; additions need a reason for the whole list.

Selected when

Section titled “Selected when”

Always selected.

Rules for coding agents

Section titled “Rules for coding agents”
Rule file Installed when
.gspot/configurations/general/docs/rules/DOCS.md Always

Tools and versions

Section titled “Tools and versions”
Tool Version
lychee 0.24.2

Files gspot writes

Section titled “Files gspot writes”

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