Skip to content

docs(audits): estate-wide documentation-debt audit 2026-05-26#197

Open
hyperpolymath wants to merge 1 commit into
mainfrom
claude/estate-audit-doc-debt-2026-05-26
Open

docs(audits): estate-wide documentation-debt audit 2026-05-26#197
hyperpolymath wants to merge 1 commit into
mainfrom
claude/estate-audit-doc-debt-2026-05-26

Conversation

@hyperpolymath
Copy link
Copy Markdown
Owner

Summary

  • Adds docs/audits/2026-05-26-estate-documentation-debt.md covering 279 git repos.
  • 5 CRITICAL (no README), 10 HIGH (stub README), 16 MEDIUM (no docs/), 123 LOW (thin docs/), 124 OK.
  • 180/279 repos missing CHANGELOG (65% gap — biggest headline).
  • 61 repos have empty docs/ dirs.
  • ~50 repos meet the user's "heavily-developed and well-organised wiki" bar.

Companion PRs

  • docs/audits/2026-05-26-estate-proof-debt.md (separate PR)
  • docs/audits/2026-05-26-estate-licence-debt.md (separate PR)
  • Per-repo docs/tech-debt-2026-05-26.md PRs to follow

🤖 Generated with Claude Code

Cross-cutting audit covering 279 git repos.

Headline findings:
- 5 repos with no README at all (CRITICAL).
- 10 repos with stub README under 20 lines (HIGH).
- 16 repos with substantial README but no docs/ tree (MEDIUM).
- 123 repos with thin docs/ (<10 files) (LOW).
- 124 repos with a heavily-developed wiki (>=10 docs files) (OK).
- 180 of 279 repos missing CHANGELOG.md (65% gap).
- 61 repos have an empty docs/ directory.

Proposes:
1. Adding a docs-template skeleton to rsr-template-repo.
2. CHANGELOG generation (git-cliff config) in governance-reusable.yml.
3. Per-repo PRs adding docs/tech-debt-2026-05-26.md to each non-OK repo.

Companion docs:
- docs/audits/2026-05-26-estate-proof-debt.md
- docs/audits/2026-05-26-estate-licence-debt.md

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@hyperpolymath hyperpolymath enabled auto-merge (squash) May 26, 2026 11:41
This was referenced May 26, 2026
hyperpolymath added a commit to hyperpolymath/absolute-zero that referenced this pull request May 26, 2026
## Summary
- Adds `docs/tech-debt-2026-05-26.md` with this repo's findings from the
estate-wide tech-debt scan.
- Covers proof debt, licence debt, documentation debt — with per-section
severity.

## What this PR does NOT do
This file records findings. It does not close the debt. Each section has
a "Recommended next move" line; closing the debt is follow-up work.

## Companion estate-wide audits
- hyperpolymath/standards#195 — proof-debt audit
- hyperpolymath/standards#196 — licence-debt audit
- hyperpolymath/standards#197 — documentation-debt audit

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 26, 2026
hyperpolymath added a commit to hyperpolymath/raze-tui that referenced this pull request May 26, 2026
## Summary
- Adds `docs/tech-debt-2026-05-26.md` with this repo's findings from the
estate-wide tech-debt scan.

## Companion estate-wide audits
- hyperpolymath/standards#195 — proof-debt
- hyperpolymath/standards#196 — licence-debt
- hyperpolymath/standards#197 — documentation-debt

Records findings only. Closing the debt is follow-up work.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
hyperpolymath added a commit to hyperpolymath/burble that referenced this pull request May 26, 2026
## Summary
- Adds `docs/tech-debt-2026-05-26.md` with this repo's findings from the
estate-wide tech-debt scan.

## Companion estate-wide audits
- hyperpolymath/standards#195 — proof-debt
- hyperpolymath/standards#196 — licence-debt
- hyperpolymath/standards#197 — documentation-debt

Records findings only. Closing the debt is follow-up work.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
hyperpolymath added a commit to hyperpolymath/formatrix-docs that referenced this pull request May 26, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant