Skip to content

finding: record-view auditing has no content/docs page — the shipped compliance capability is documented only in a package README #9540

Description

@os-project-manager

Observation-class finding, recorded while completing #9517's residual half (documenting the read-audit surface in packages/plugins/plugin-audit/README.md). ⛔ Not a defect claim — nothing states anything false. Filing because the measurement is cheap to lose and expensive to re-take.

Measurement

Record-view auditing landed with #8992 / PR #9515 (5126e795d). On origin/main at 53fc09922, the docs corpus has no page for it:

grep -rn "readAudit\|record_views\|record-view" content/docs   # no hits

The seven content/docs pages that mention sys_audit_log at all are ui/setup-app.mdx, protocol/kernel/config-resolution.mdx, kernel/runtime-services/audit-service.mdx, deployment/production-readiness.mdx, plugins/packages.mdx and two release pages. None describes the read action, the per-object opt-in, or the record-detail scope.

content/docs/capabilities/permissions.mdx:23 describes audit as "records who changed what, when, with old and new values". That is not false — it is a write-side description that has simply not been extended. I am deliberately not calling it drift.

Why it might matter, stated narrowly

The capability was built for a regulated-industry buyer, and the only place its scope is written down is a package README on npm. The scope has real edges someone evaluating coverage needs — record-detail views only, per-object opt-in, no field values recorded, system-elevated reads excluded — and a coverage question answered from the docs site alone currently gets silence rather than those edges.

⇒ Two honest dispositions, both fine, which is why this is a finding and not queued:

  • Add a docs page (or a section on an existing capability page) mirroring the README's new "Record-view auditing" section. The content already exists and is source-verified.
  • Decide the package README is the right home for a plugin-level opt-in and close this. check:affected-docs is green on the PR that documented it, so no gate believes a docs page is owed.

Refs: #9517 (the README card) · #8992 / PR #9515 (the capability) · #9534 (a separate, real mismatch on audit-service.mdx).

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

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions