|
| 1 | +<!-- |
| 2 | +SPDX-License-Identifier: MPL-2.0 |
| 3 | +SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath) |
| 4 | +--> |
| 5 | + |
| 6 | +# Tech-Debt Audit — formatrix-docs — 2026-05-26 |
| 7 | + |
| 8 | +**Source:** estate-wide automated scan 2026-05-26. |
| 9 | +**Companion:** [`hyperpolymath/standards` 2026-05-26-estate-*-debt audits](https://github.com/hyperpolymath/standards/tree/main/docs/audits). |
| 10 | +**Combined severity:** `2026-05-22`. |
| 11 | + |
| 12 | +This file records the *raw findings* — it does not by itself fix the debt. Each section ends with a 'Recommended next move' line; closing the debt is follow-up work. |
| 13 | + |
| 14 | +## 1. Proof debt |
| 15 | + |
| 16 | +Scanner counted the following markers in proof-bearing files of this repo: |
| 17 | + |
| 18 | +``` |
| 19 | +files= 10 | Coq-Axm/Adm= 0 | Lean-srry/ax= 0 | Agda-pst= 0 | Idr-blv= 0 | Idr-prtl= 0 | Fstr-asm= 0 | TODO= 0 | Unsafe= 0 |
| 20 | +``` |
| 21 | + |
| 22 | +**Total markers:** 0. **Severity:** `>00`. |
| 23 | + |
| 24 | +**Recommended next move:** none — no proof-debt markers detected. |
| 25 | + |
| 26 | +## 2. Licence debt |
| 27 | + |
| 28 | +| Field | Value | |
| 29 | +|---|---| |
| 30 | +| LICENSE file | `LICENSE` | |
| 31 | +| SPDX header | `MPL-2.0` | |
| 32 | +| Manifest licence | `MPL-2.0` | |
| 33 | +| Body classifier | `Palimp-MPL-2.0` | |
| 34 | +| Severity | `ok` | |
| 35 | + |
| 36 | +**Recommended next move:** none for licence. |
| 37 | + |
| 38 | +## 3. Documentation debt |
| 39 | + |
| 40 | +| Field | Value | |
| 41 | +|---|---| |
| 42 | +| README lines | 146 | |
| 43 | +| `docs/` files | 5 | |
| 44 | +| `docs/` LoC | 1569 | |
| 45 | +| CHANGELOG.md | N | |
| 46 | +| CONTRIBUTING.md | Y | |
| 47 | +| CODE_OF_CONDUCT.md | Y | |
| 48 | +| SECURITY.md | Y | |
| 49 | +| Severity | `readme=146 docs=5/1569` | |
| 50 | + |
| 51 | + |
| 52 | +Additionally: **CHANGELOG.md is missing.** 65% of estate repos lack one — adopting a CHANGELOG (or auto-generating via `git-cliff`) is a recommended estate-wide follow-up. |
| 53 | + |
| 54 | +## Cross-references |
| 55 | + |
| 56 | +- Estate proof-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-proof-debt.md` |
| 57 | +- Estate licence-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-licence-debt.md` |
| 58 | +- Estate documentation-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-documentation-debt.md` |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +🤖 Generated by Claude Code estate-wide tech-debt scan (2026-05-26). This file is informational — closing the debt is follow-up work owned by the maintainer. |
0 commit comments