docs/missing-paths
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.
Part of the docs configuration, at the recommended level. It runs at the commit stage, once for the repository. gspot runs this check itself.
A stale path in the docs sends the reader to a deleted file.
What to do
Section titled “What to do”Fix the path or the task name. Give an example code block a title= attribute.
Example
Section titled “Example”A path in the docs that points to a deleted file reports a stale reference. Update the path and any command that uses it.
Turn it off
Section titled “Turn it off”Turn it off for some files, with a reason:
gspot ignore docs/missing-paths --paths "<glob>" --reason "<why>"