Skip to content

docs/ is swept by no gate — 27 findings across 9 files sit behind a green docs:drift #604

Description

@serge-ivo

docs/ is read by no CI step, and all 27 known doc findings live there

Measured 2026-08-15. scripts/docs-drift.mjs's docFiles() collects platform-docs/, not docs/; servedHtmlFiles() skips any directory named docs. No gate reads docs/ at all.

The consequence is measured, not theoretical: an audit of 21 files under docs/ found 27 findings across 9 docs, while pnpm docs:drift passes all 13 checks. Nine of the 21 are clean — including two verified exact to the byte — so this is not "docs rot", it is "docs rot invisibly".

This is the #555 class one directory over, and the third instance of the same defect today: a guard whose population silently excludes the thing it exists to catch (see #600, #603).

One concrete drift to fix in the same commit, as the proof case: docs/mcp-instance-runtime.md states a tool count that disagrees with MCP_TOOL_COUNT and a /health figure of 41 against the live 136.

Acceptance criteria

  1. docFiles() covers docs/**/*.md, with a requireInputs floor per ADR 0002 — the collector must fail when it gathers implausibly little, since "found nothing" and "found nothing wrong" print the same tick.
  2. docs/mcp-instance-runtime.md's count drift is fixed, and the guard is demonstrated red on it first.
  3. The success line states its denominator: files swept and claims checked, distinguishing the two. docs-drift swept the file and missed a stale 124 — the detector matches phrasings, so its denominator counts files read, not claims checked #603 is open on exactly that distinction — coordinate rather than inventing a second convention.
  4. Historical documents must not be forced to state current numbers. An ADR describing a June decision is correct as history; establish how the guard distinguishes them, or scope it to files that make present-tense claims.

Verified vs inferred

  • Verified: both collector behaviours; that docs:drift passes with the drift present; the 21/27/9 audit counts.
  • Inferred: that extending the collector is sufficient. AC4's historical-document question may make it harder than a path change — settle that before implementing.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions