agentops/docs/contracts/agents-documentation-authority.yaml at main · boshu2/agentops · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
schema_version: agentops-documentation-authority.v1
status: active

# This contract records human and agent judgments; the checker proves only
# filesystem, index, ownership-path, and literal-reference facts.
scope:
  root_markdown_count: 10
  reference_excludes:
    - glob: .agents/rpi/**
      reason: generated runtime evidence
    - glob: docs/releases/**
      reason: immutable release history
    - glob: docs/plans/**
      reason: historical planning records
    - glob: docs/audits/**
      reason: point-in-time audit evidence
    - glob: docs/provenance/**
      reason: append-only provenance evidence
    - glob: docs/handoffs/**
      reason: historical session handoffs
    - glob: spec/teardown-2026-05-28/**
      reason: archived teardown specification
    - glob: CHANGELOG.md
      reason: immutable release history

documents:
  - path: AGENTS.md
    tracked: true
    class: operating-contract
    disposition: retain-and-tighten
    owner: AGENTS.md
    proof: scripts/check-cathedral-cut-conformance.py plus fresh-context verdicts
    references:
      phase_policy: {inventory: exact, pre-cutover: exact, cutover: exact}
      include_globs:
        - docs/agent-workflow-reference.md
        - docs/CI-CD.md
        - docs/contracts/codex-skill-api.md
      consumers:
        - docs/agent-workflow-reference.md
        - docs/CI-CD.md
        - docs/contracts/codex-skill-api.md

  - path: CLAUDE.md
    tracked: true
    class: compatibility-adapter
    disposition: retain-symlink
    owner: AGENTS.md
    proof: factual symlink and owner-path checks

  - path: README.md
    tracked: true
    class: public-entrypoint
    disposition: retain-and-tighten
    owner: README.md
    proof: scripts/check-cathedral-cut-conformance.py plus fresh-context verdicts

  - path: PRODUCT.md
    tracked: true
    class: product-contract
    disposition: retain-and-tighten
    owner: PRODUCT.md
    proof: scripts/check-cathedral-cut-conformance.py

  - path: GOALS.md
    tracked: true
    class: fitness-contract
    disposition: retain-and-tighten
    owner: GOALS.md
    proof: ao goals validate --json

  - path: CHANGELOG.md
    tracked: true
    class: release-history
    disposition: retain-historical
    owner: CHANGELOG.md
    proof: tests/docs/validate-doc-release.sh

  - path: PROGRAM.md
    tracked: true
    class: product-boundary
    disposition: retain-and-tighten
    owner: PROGRAM.md
    proof: Cathedral Cut conformance

  # MEMORY.md is a temporary machine-consumed projection, not an AgentOps
  # authority: its claims belong to their cited sources (docs, ADRs, session
  # records). Consumer audit (2026-08-07): two live consumers exist — the
  # corpus-delta eval harness (scripts/corpus-delta-harness.sh reads it as a
  # context surface in both A/B arms) and the coding-agent convention of
  # loading a root memory file. The former ao session memory writer is
  # removed, so the file is read-only surface. Retained; retire when the
  # harness stops reading it and the convention is served by a caller-owned
  # memory system.
  - path: MEMORY.md
    tracked: true
    class: machine-consumed-memory-projection
    disposition: retain-until-consumers-migrate
    owner: MEMORY.md
    proof: factual path and consumer audit

  - path: PRACTICE-REGISTRY.md
    tracked: true
    class: machine-consumed-practice-registry
    disposition: retain-until-structured-owner-exists
    owner: PRACTICE-REGISTRY.md
    proof: scripts/validate-practice-citations.sh

  - path: release-notes.md
    tracked: false
    presence: optional-generated
    class: ignored-generated-runtime-output
    disposition: preserve-outside-repository-cleanup
    owner: scripts/extract-release-notes.sh
    proof: tests/docs/validate-doc-release.sh