Skip to content

Commit d884a78

Browse files
docs: record tech-debt audit findings (2026-05-26) (#19)
Adds docs/tech-debt-2026-05-26.md with this repo's findings from the estate-wide tech-debt scan: proof debt, licence debt, documentation debt. This file records the findings only — it does not close the debt. Cross-references: - hyperpolymath/standards#195 (estate proof-debt audit) - hyperpolymath/standards#196 (estate licence-debt audit) - hyperpolymath/standards#197 (estate documentation-debt audit) Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6fd8905 commit d884a78

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

docs/tech-debt-2026-05-26.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!--
2+
SPDX-License-Identifier: MPL-2.0
3+
SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
4+
-->
5+
6+
# Tech-Debt Audit — intsoc-transactor — 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:** `LOW`.
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+
No proof-bearing files (`*.v`, `*.lean`, `*.agda`, `*.idr`, `*.idr2`, `*.fst`, `*.dfy`, `*.tla`, `*.ads`, `*.adb`) found in this repo.
17+
18+
**Recommended next move:** none.
19+
20+
## 2. Licence debt
21+
22+
| Field | Value |
23+
|---|---|
24+
| LICENSE file | `LICENSE` |
25+
| SPDX header | `MPL-2.0` |
26+
| Manifest licence | `MPL-2.0` |
27+
| Body classifier | `Palimp-MPL-2.0` |
28+
| Severity | `ok` |
29+
30+
**Recommended next move:** none for licence.
31+
32+
## 3. Documentation debt
33+
34+
| Field | Value |
35+
|---|---|
36+
| README lines | 100 |
37+
| `docs/` files | 13 |
38+
| `docs/` LoC | 1413 |
39+
| CHANGELOG.md | Y |
40+
| CONTRIBUTING.md | Y |
41+
| CODE_OF_CONDUCT.md | Y |
42+
| SECURITY.md | Y |
43+
| Severity | `LOW` |
44+
45+
**Recommended next move:** `docs/` has only 13 file(s). Aim for ≥10 organised docs (architecture, usage, contributing-guide, troubleshooting, design-decisions). The user's bar for a "heavily-developed and well-organised wiki" is ≥10 files with topical organisation.
46+
47+
## Cross-references
48+
49+
- Estate proof-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-proof-debt.md`
50+
- Estate licence-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-licence-debt.md`
51+
- Estate documentation-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-documentation-debt.md`
52+
53+
---
54+
55+
🤖 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

Comments
 (0)