@amsterdamdatalabs/adl-agent-control-darwin-arm64 0.1.4

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/docs-knowledge-indexes.yaml

@@ -0,0 +1,192 @@
+schema_version: 1
+
+discovery:
+  - '.specs/*/index.md'
+  - 'docs/architecture/index.md'
+  - 'docs/research/index.md'
+  - 'docs/compliance/index.md'
+  - 'docs/operations/index.md'
+  - 'docs/architecture/product/index.md'
+
+indexes:
+  - id: specs-backend
+    path: .specs/backend/index.md
+    kind: specification-family
+    root: .specs/backend
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-billing
+    path: .specs/billing/index.md
+    kind: specification-family
+    root: .specs/billing
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-capabilities
+    path: .specs/capabilities/index.md
+    kind: specification-family
+    root: .specs/capabilities
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-compliance
+    path: .specs/compliance/index.md
+    kind: specification-family
+    root: .specs/compliance
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-execution
+    path: .specs/execution/index.md
+    kind: specification-family
+    root: .specs/execution
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-messaging
+    path: .specs/messaging/index.md
+    kind: specification-family
+    root: .specs/messaging
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-sandbox
+    path: .specs/sandbox/index.md
+    kind: specification-family
+    root: .specs/sandbox
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: [Scope, Sources of truth]
+    display_status: false
+
+  - id: specs-teams
+    path: .specs/teams/index.md
+    kind: specification-family
+    root: .specs/teams
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-collaboration
+    path: .specs/collaboration/index.md
+    kind: specification-family
+    root: .specs/collaboration
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-frontend
+    path: .specs/frontend/index.md
+    kind: specification-family
+    root: .specs/frontend
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: specs-tenancy
+    path: .specs/tenancy/index.md
+    kind: specification-family
+    root: .specs/tenancy
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [type, title, description, status, generated, owner, requirement_prefix, sources]
+    required_sections: []
+    display_status: false
+
+  - id: docs-architecture
+    path: docs/architecture/index.md
+    kind: documentation-catalog
+    root: docs/architecture
+    recursive: true
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    exclude_prefixes: [product/]
+    required_frontmatter: [title, description, document_type, status, last_update, reason]
+    required_sections: [Reading order]
+    display_status: true
+    status_map: {draft: draft, stable: stable}
+
+  - id: docs-research
+    path: docs/research/index.md
+    kind: documentation-catalog
+    root: docs/research
+    recursive: true
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [title, description, document_type, status, last_update, reason]
+    required_sections: []
+    display_status: true
+    status_map: {draft: draft, canonical: canonical, stable: stable}
+
+  - id: docs-compliance
+    path: docs/compliance/index.md
+    kind: documentation-catalog
+    root: docs/compliance
+    recursive: true
+    include_extensions: [.md, .yaml, .yml]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [title, description, document_type, status, last_update, reason]
+    required_sections: []
+    display_status: true
+    status_map: {canonical: stable, draft: draft, '-': metadata}
+
+  - id: docs-operations
+    path: docs/operations/index.md
+    kind: documentation-catalog
+    root: docs/operations
+    recursive: false
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [title, description, document_type, status, last_update, reason]
+    required_sections: []
+    display_status: true
+    status_map: {draft: draft, stable: stable}
+
+  - id: docs-product
+    path: docs/architecture/product/index.md
+    kind: hand-maintained-catalog
+    root: docs/architecture/product
+    recursive: true
+    include_extensions: [.md]
+    exclude_names: [index.md, AGENTS.md, CLAUDE.md]
+    required_frontmatter: [title, description, document_type, status, last_update, reason]
+    required_sections: [Normative, "Input, not authority", The schema itself]
+    display_status: false
+    inventory: exempt

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-clean/docs/index.md

@@ -0,0 +1,14 @@
+---
+title: Documentation catalog
+description: Fixture catalog that lists every governed page.
+---
+
+# Documentation catalog
+
+Every page under the governed root is listed below, which is the clean case
+the paired test asserts against.
+
+| Page | Summary |
+| --- | --- |
+| [One](one.md) | the first governed page |
+| [Two](two.md) | the second governed page |

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-clean/docs/one.md

@@ -0,0 +1,7 @@
+---
+title: One
+---
+
+# One
+
+A governed page the catalog lists.

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-clean/docs/two.md

@@ -0,0 +1,7 @@
+---
+title: Two
+---
+
+# Two
+
+A governed page the catalog also lists.

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-clean/docs-knowledge-indexes.yaml

@@ -0,0 +1,20 @@
+# Fixture input for DOC-008 (docs.indexes) — a cut-down registry naming one
+# catalogue, passed as the `registry` input override. Same content as
+# compliance_new/checks/docs/indexes/fixtures/knowledge-indexes-clean's copy,
+# flattened to the fixture root rather than nested under the shell tree's own
+# compliance/checks/docs/indexes/ path (that nesting was an artifact of the
+# shell check's cwd-relative CONFIG constant, not subject matter).
+schema_version: 1
+indexes:
+  - id: docs-catalog
+    path: docs/index.md
+    kind: documentation-catalog
+    root: docs
+    recursive: true
+    inventory: exact
+    include_extensions:
+      - .md
+    required_frontmatter:
+      - title
+      - description
+    required_sections: []

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-duplicate/docs/index.md

@@ -0,0 +1,15 @@
+---
+title: Documentation catalog
+description: Fixture catalog that lists one governed page twice.
+---
+
+# Documentation catalog
+
+Every governed page appears, and `one.md` appears twice: the inventory is
+complete, so the only defect is the repetition.
+
+| Page | Summary |
+| --- | --- |
+| [One](one.md) | the first governed page |
+| [Two](two.md) | the second governed page |
+| [One](one.md) | the repeated entry |

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-duplicate/docs/one.md

@@ -0,0 +1,7 @@
+---
+title: One
+---
+
+# One
+
+A governed page the catalog lists.

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-duplicate/docs/two.md

@@ -0,0 +1,7 @@
+---
+title: Two
+---
+
+# Two
+
+A governed page the catalog lists.

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-duplicate/docs-knowledge-indexes.yaml

@@ -0,0 +1,16 @@
+# Fixture input for DOC-008 (docs.indexes). See knowledge-indexes-clean's copy
+# for the flattening note.
+schema_version: 1
+indexes:
+  - id: docs-catalog
+    path: docs/index.md
+    kind: documentation-catalog
+    root: docs
+    recursive: true
+    inventory: exact
+    include_extensions:
+      - .md
+    required_frontmatter:
+      - title
+      - description
+    required_sections: []

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-missing-entry/docs/index.md

@@ -0,0 +1,13 @@
+---
+title: Documentation catalog
+description: Fixture catalog that omits one governed page.
+---
+
+# Documentation catalog
+
+`two.md` sits under the governed root and is deliberately absent from the table
+below, which is the KNW-001 the paired test asserts.
+
+| Page | Summary |
+| --- | --- |
+| [One](one.md) | the page the catalog does list |

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-missing-entry/docs/one.md

@@ -0,0 +1,7 @@
+---
+title: One
+---
+
+# One
+
+A governed page the catalog lists.

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-missing-entry/docs/two.md

@@ -0,0 +1,7 @@
+---
+title: Two
+---
+
+# Two
+
+A governed page the catalog omits. This is the violation.

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/fixtures/knowledge-indexes-missing-entry/docs-knowledge-indexes.yaml

@@ -0,0 +1,16 @@
+# Fixture input for DOC-008 (docs.indexes). See knowledge-indexes-clean's copy
+# for the flattening note.
+schema_version: 1
+indexes:
+  - id: docs-catalog
+    path: docs/index.md
+    kind: documentation-catalog
+    root: docs
+    recursive: true
+    inventory: exact
+    include_extensions:
+      - .md
+    required_frontmatter:
+      - title
+      - description
+    required_sections: []

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/indexes/test_check.py

@@ -0,0 +1,102 @@
+"""DOC-008 — ported from `compliance_new/checks/docs/indexes/test.sh`.
+
+Three committed corpora, same scenario names and same file content as the
+shell fixtures under
+`compliance_new/checks/docs/indexes/fixtures/knowledge-indexes-{clean,
+missing-entry,duplicate}/` — only the registry input is flattened to the
+fixture root rather than nested under the shell tree's own `compliance/
+checks/docs/indexes/` path (see `knowledge-indexes-clean/
+docs-knowledge-indexes.yaml`'s own comment).
+
+This wave's checks are wired into `checks/__init__.py` in a later, single pass
+(see the folder's own docstring / the dispatch instructions), so `Indexes` is
+not yet registered under `checks.lookup`. Rather than call `runner.run()` —
+which would resolve `DOC-008` to "no check implements it" and report
+`COULD_NOT_RUN` for the wrong reason — `_run` below builds the `Context`
+directly and drives the check the same way `runner.run` would, exactly as
+`CON-003`'s (`contracts.transport_boundaries`) test harness does for the same
+reason.
+
+Not ported: `test.sh`'s "isolation proof" (that the gate reports nothing from
+outside the corpus it was pointed at) and its "no set: could not run" case.
+Both are shell-runner concerns with no equivalent at the `Check` level —
+`corpus_files` enumerates only the fixture root by construction, so there is
+no repository-root leak to prove against, and `graded(ctx, files)` is always
+handed a `FileSet` (see `DOC-004`'s `test_check.py`, which records the
+identical omission for `docs.index-updated`).
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from pathlib import Path
+
+from helpers import corpus, corpus_files
+
+from adl_compliance.checks.docs.indexes import Indexes
+from adl_compliance.core import scope
+from adl_compliance.core.context import Context, FileSet
+from adl_compliance.core.errors import CouldNotRun
+from adl_compliance.core.verdict import Outcome, Verdict, could_not_run, decide
+from adl_compliance.policy.registry import load
+
+FIXTURES = corpus("docs", "indexes")
+CLEAN = FIXTURES / "knowledge-indexes-clean"
+MISSING_ENTRY = FIXTURES / "knowledge-indexes-missing-entry"
+DUPLICATE = FIXTURES / "knowledge-indexes-duplicate"
+
+ROW = load().by_id("DOC-008")
+
+
+def _run(root: Path, *, given: Sequence[str] | None = None) -> Verdict:
+    """`runner.run`'s scope-narrow-then-decide, against this check directly —
+    the same bypass `CON-003`'s test uses for an unwired check."""
+    raw = corpus_files(root) if given is None else tuple(given)
+    narrowed = FileSet(paths=scope.intersect(ROW.resolved_scope(), raw))
+    ctx = Context(root=root, row=ROW, inputs={"registry": root / "docs-knowledge-indexes.yaml"})
+    try:
+        findings = tuple(Indexes().run(ctx, narrowed))
+    except CouldNotRun as exc:
+        return could_not_run(ROW, str(exc))
+    return decide(ROW, findings, 0, ())
+
+
+# -------------------------------------------------------------------- clean
+
+def test_a_catalog_listing_every_governed_page_is_clean() -> None:
+    verdict = _run(CLEAN)
+    assert verdict.outcome is Outcome.CLEAN, verdict.render()
+    assert verdict.findings == ()
+
+
+# ---------------------------------------------------------------- violation
+
+def test_a_catalog_missing_a_governed_page_is_reported() -> None:
+    verdict = _run(MISSING_ENTRY)
+    assert verdict.outcome is Outcome.FINDINGS, verdict.render()
+    assert verdict.rules == ["KNW-001"]
+    finding = verdict.findings[0]
+    assert finding.path == "docs/index.md"
+    assert finding.message == "catalog missing docs/two.md"
+
+
+# ---------------------------------------------------------------- duplicate
+
+def test_a_page_catalogued_twice_is_reported_as_a_duplicate_not_missing_or_extra() -> None:
+    verdict = _run(DUPLICATE)
+    assert verdict.outcome is Outcome.FINDINGS, verdict.render()
+    assert verdict.rules == ["KNW-001"]
+    finding = verdict.findings[0]
+    assert finding.path == "docs/index.md"
+    assert finding.message == "duplicate catalog entry docs/one.md"
+    assert "catalog missing" not in finding.message
+    assert "outside inventory" not in finding.message
+
+
+# ------------------------------------------- intersection, half one: the set
+
+def test_the_omitted_page_outside_the_given_set_is_not_reported() -> None:
+    """The missing-entry corpus, unchanged on disk, but `docs/two.md` is not
+    in the given set this time — so there is nothing to compare it against."""
+    verdict = _run(MISSING_ENTRY, given=("docs/index.md", "docs/one.md"))
+    assert verdict.outcome is Outcome.CLEAN, verdict.render()

package/packages/repo-controls/package/adl-compliance/src/adl_compliance/checks/docs/ledger/__init__.py

@@ -0,0 +1,12 @@
+"""The `docs.ledger` gate.
+
+A folder rather than a module because this gate GRADES A DOCUMENT, and the
+document belongs beside the check that reads it. `check.py` is the rule;
+`fixtures/` is what it grades.
+"""
+
+from __future__ import annotations
+
+from .check import DocsLedger
+
+__all__ = ["DocsLedger"]