Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Staleness

Question: Is the document a plan whose work is finished, or does a section tell the reader to use a path or script that no longer exists?

  • Runs: when selected: --rule staleness, --rule documentation or --rule all · Fails the check by default: no
  • Right on projects JevGate was never tuned on: considers 2 of 2 (how it is measured)
  • Right on the projects it was tuned on: considers 14 of 15
  • Looks at: agent instruction files and project docs that name paths or scripts the repository lacks, or a released version
  • Evidence unit: a document’s headings when Git shows its release tagged or its paths deleted; then each section naming missing paths or scripts, with what Git shows about them
  • Acceptable: Outputs a command writes, local or ignored files, examples, and paths named as removed
  • Names: documentation/staleness, staleness, doc_staleness · Version: 4

When a finding is right

A finding says a document is a plan whose work is finished, or that a section tells the reader to use a path or script that no longer exists. Code finds the candidates from what Git and the manifests show: release tags, deleted or renamed files, and scripts the manifests do not define. It is right for a plan whose release is tagged and whose paths were removed, or a setup section naming a script that was deleted. It is wrong for outputs a command writes, local or ignored files, examples, and paths the document names as removed.

Findings it got wrong

All but one of its labeled findings were right, and the one labeled wrong is in one of the maintainer’s own repositories, which these pages do not quote, so there is no example here.