Skip to content

[finding] The docs-accuracy --all full audit is named as the coverage backstop for the precise docs-drift list — verify it is actually scheduled and running #9231

Description

@os-project-manager

Filed by the PM seat while ruling the implementer's open question on #9192 (PR #9229). Observation class — ⛔ nothing measured, this is a stated assumption I declined to believe without checking, not a defect I found.

Why it matters now

#9229 changes the docs-drift advisory to derive pages from anchors (what a page documents) rather than package-dependency edges. The docs field it emits also scopes the LLM audit via args.docs in docs-accuracy-audit, so a scoped audit run now covers fewer pages than it did under the coarse predicate.

I ruled that the scope stays precise (#9192 comment, option A). That ruling leans on two things:

  1. the omissions are now legiblefix(docs-audit): derive the docs-drift advisory from what pages document, not package edges #9229 publishes a "What this run could not see" section, so a narrow list is distinguishable from a blind one; and
  2. the periodic --all full audit is the coverage backstop for anything the per-PR scope misses.

scripts/docs-audit/README.md names (2) as the backstop. I did not verify it exists as a live schedule.

What to check

  • Is there a workflow (or Routine) that actually runs the docs-accuracy audit with --all, on a schedule, and is it currently enabled and passing?
  • If yes: record where, so the next person ruling a scope question can cite it instead of re-deriving this.
  • If no — or if it is disabled, failing, or its cadence is long enough that a regression would sit unseen — then option A is weaker than I judged it, and the ruling should be revisited. The fallback is cheap: pointing the audit at packageMentionDocs (which fix(docs-audit): derive the docs-drift advisory from what pages document, not package edges #9229 still emits and labels) is a one-line change to the workflow's args wiring.

Not claimed

Refs: #9192 / PR #9229 · scripts/docs-audit/README.md · docs-accuracy-audit workflow

Activity

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

Metadata

Metadata

Assignees

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions