// SPDX-License-Identifier: CC-BY-SA-4.0
// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= avow-protocol — thin binding
:toc:

This directory is NOT a copy of the avow-protocol codebase. It is a
pointer. Do not add protocol text, source, docs, or templates here —
they belong in the canonical repo below.

== Canonical repository

https://github.com/hyperpolymath/avow-protocol[hyperpolymath/avow-protocol]
is the single source of truth for all avow-protocol content: protocol
spec, source, docs, tests, and governance.

== Standards this component opts into

* `LICENCE-POLICY.adoc` — canonical MPL-2.0 (code) / CC-BY-SA-4.0 (docs) pair
* Reusable CI workflows: Scorecard, Hypatia scan, Governance bundle
* `.machine_readable/contractiles/` obligation-typing convention

== Known gaps (tracked, not fixed by this binding)

* The real repo's `.machine_readable/6a2/` has not yet migrated to
  `descriptiles` per the estate naming mandate (2026-06-30). Tracked
  debt in the real repo, out of scope here.

== History

Prior to 2026-07-02 this directory held a full duplicate of the
avow-protocol codebase that had genuinely diverged from the real repo
(roughly a week apart in currency). The duplicate was removed as part
of the standards thin-binding pilot
(`dev-notes/handoffs/2026-07-02-standards-thin-binding-pilot-handoff.md`).

Before removal, the nested copy was diffed against the real repo in
full. One piece of unique content had no home in the real repo:
`avow-lib/` (Idris2 formal-verification tests, ABI source, Zig FFI).
It was migrated to the real repo first, so it wasn't discarded:
https://github.com/hyperpolymath/avow-protocol/pull/24

Everything else unique to the old nested copy was confirmed superseded
by later work in the real repo (AffineScript `.affine` sources replaced
by ReScript `.res` equivalents, `README.adoc` converted to `README.md`,
local issue templates retired in favour of the org's `.github` canon)
or was unrendered RSR template scaffold with no real content
(`{{PROJECT}}` placeholders, never instantiated).
