docs(tidy): T-3 — audit + plan + minimal .well-known/{ai,humans}.txt#368
docs(tidy): T-3 — audit + plan + minimal .well-known/{ai,humans}.txt#368hyperpolymath wants to merge 1 commit into
Conversation
Audit and plan for the repo-wide doc-tidy initiated 2026-05-25, plus the two minimal RSR-compliance additions that don't need their own PR. ## What this PR ships 1. **docs/TIDY-PLAN.adoc** — the master plan. Catalogues every file in scope, assigns each a disposition (KEEP / MERGE / RENAME / ARCHIVE / DELETE), and enumerates the remaining work as 22 thematic T-4..T-24 PRs with recommended merge order. Acknowledges T-1 (#359), T-2 (#360), and the CLAUDE.md refresh (#363) which already landed. 2. **.well-known/ai.txt** (new) — RSR-required AI-usage discovery file. Companion to the existing root-level 0-AI-MANIFEST.a2ml (which T-1 introduced); summarises the project's posture toward AI-generated contributions and points at the structured manifest + .claude/CLAUDE.md for full detail. 3. **docs/humans.txt → .well-known/humans.txt** (move) — humans.txt was at the wrong path; RSR convention (and humans-txt.org) require it under .well-known/. No external references to update; content unchanged. ## Why a plan PR first The cleanup blast-radius is real (e.g., docs/CAPABILITY-MATRIX.adoc is cited 27x; moving it to docs/status/ in T-8 requires updating every cite). Per the owner's "sequence of thematic PRs" instruction and the standing DOC-DEDUP rule, surfacing the plan in a tracked document lets each subsequent T-N PR cite it for scope, and lets reviewers verify nothing escapes the plan or duplicates earlier work. ## Audit sources - RSR template: hyperpolymath/rsr-template-repo (fetched via WebFetch) - Per-file disposition: Explore-agent audit of top-level + docs/ + subdir READMEs + .machine_readable/ A2ML files + CLAUDE.md - Open issues/PRs: GitHub MCP enumeration Both audits dated 2026-05-25. ## Test plan - [ ] `cat .well-known/ai.txt` returns the policy summary - [ ] `.well-known/humans.txt` resolves and matches the prior docs/humans.txt content - [ ] No broken cross-references introduced (only T-3 references the `.well-known/{ai,humans}.txt` files; nothing in the prior tree referenced docs/humans.txt) - [ ] No CI behaviour change (the plan document and the two .well-known additions don't intersect with any code path or test) Refs the doc-tidy mandate from the 2026-05-25 conversation.
🔍 Hypatia Security ScanFindings: 103 issues detected
View findings[
{
"reason": "Action hyperpolymath/standards/.github/workflows/governance-reusable.yml@main needs attention",
"type": "unpinned_action",
"file": "governance.yml",
"action": "pin_sha",
"rule_module": "workflow_audit",
"severity": "high"
},
{
"reason": "Action actions/checkout@v6 needs attention",
"type": "unpinned_action",
"file": "publish-jsr.yml",
"action": "pin_sha",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Action denoland/setup-deno@v2 needs attention",
"type": "unpinned_action",
"file": "publish-jsr.yml",
"action": "pin_sha",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/affinescript-deno-test/example/smoke_driver.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/affinescript-deno-test/cli.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/affinescript-deno-test/mod.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/affinescript-deno-test/lib/compile.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/affinescript-deno-test/lib/runner.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/affinescript-deno-test/lib/discover.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
},
{
"reason": "TypeScript file detected -- banned language",
"type": "banned_language_file",
"file": "/home/runner/work/affinescript/affinescript/packages/affine-js/types.d.ts",
"action": "flag",
"rule_module": "cicd_rules",
"severity": "critical"
}
]Powered by Hypatia Neurosymbolic CI/CD Intelligence |
Session log — 2026-05-24..26Tying together the work this PR caps off, for human discoverability. Machine-readable state is already current in CORE-01 Phase 3 — borrow-checker
Repo-tidy
CI signal (for future agents)These checks fail on every PR for baseline reasons (not anything in any individual PR's diff). Documented in
A real new finding shows as a delta in the count; otherwise treat as baseline. T-24 plans to extract the exemption tables into What lives where
Safe-to-close conditionsThis PR's merge or close auto-unsubscribes the session. The borrow-checker work is fully merged; the doc-tidy continues from T-4 onward with the plan as the single source of truth — any subsequent agent or human session can pick it up cold. Generated by Claude Code |
Summary
Audit + plan for the repo-wide doc-tidy, plus the two minimal RSR-compliance additions that don't warrant their own PR.
docs/TIDY-PLAN.adoc is the master plan. It catalogues every file in scope, assigns each a disposition, and enumerates the remaining work as 22 thematic T-4..T-24 PRs with recommended merge order. Acknowledges T-1 (#359), T-2 (#360), and the CLAUDE.md refresh (#363) which already landed — does not re-propose their work.
.well-known/ai.txt (new) and .well-known/humans.txt (moved from
docs/humans.txt) close two RSR-compliance gaps; both are small enough to ride along with the plan.Why a plan PR first
The cleanup blast-radius is real (e.g.,
docs/CAPABILITY-MATRIX.adocis cited 27x; moving it todocs/status/in T-8 requires updating every cite). Per the owner's "sequence of thematic PRs" instruction and the standing DOC-DEDUP rule, surfacing the plan in a tracked document lets each subsequent T-N PR cite it for scope, and lets reviewers verify nothing escapes the plan or duplicates earlier work.Audit sources
Both audits dated 2026-05-25.
Headline RSR-template gaps remaining
Justfile+validate-rsrrecipeflake.nix(orguix.scm).editorconfig+.gitattributesdocs/specs/SETTLED-DECISIONS.adoc→ per-ADR indocs/decisions/docs/{CAPABILITY-MATRIX,TECH-DEBT}.adoc→docs/status/docs/ECOSYSTEM.adoc→docs/architecture/docs/{guides,tutorial}/→docs/{onboarding,developer}/docs/academic/→docs/{theory,whitepapers}/docs/history/→docs/archive/.machine_readable/6a2/A2ML hygiene(Full table with risk and rationale in
docs/TIDY-PLAN.adoc.)Diff
docs/TIDY-PLAN.adoc— the plan (~430 lines, AsciiDoc).well-known/ai.txt— minimal AI-usage discovery file, points to root0-AI-MANIFEST.a2mldocs/humans.txt→.well-known/humans.txt— content unchanged; no incoming references to updateTest plan
.well-known/ai.txtresolves and contains the policy summary.well-known/humans.txtresolves and matches priordocs/humans.txtcontentdocs/humans.txt.well-known/additions don't intersect with any code pathRefs the doc-tidy mandate from the 2026-05-25 conversation. Sequel to T-1 (#359), T-2 (#360).
Generated by Claude Code