Skip to content

docs: refresh README/EXPLAINME, RSR + bot-doc compliance, clean root - #55

Merged
hyperpolymath merged 4 commits into
mainfrom
claude/confident-albattani-okm8i5
Jun 20, 2026
Merged

hyperpolymath merged 4 commits into
mainfrom
claude/confident-albattani-okm8i5

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Summary

Documentation refresh + full RSR/standards compliance + root cleanup, in the order requested:

  1. README.adoc → current status
  2. EXPLAINME.adoc
  3. RSR-template-repo + standards compliance — docs sorted for humans and bots
  4. Root cleared of cruft; machine-readable artefacts relocated; adoc-first

No source code is touched — this is docs / metadata / config / cruft only. The ExUnit suite remains green.

1 — README.adoc

  • Version Standard Candidate 1.00.9.0 (matches mix.exs).
  • Corrected the probabilistic-types claim: they are runtime-represented, with static checking on the roadmap — the old table said "statically checked types", which EXPLAINME contradicts.
  • Added the reflexion design layer to the IP/claims table.
  • Replaced the aspirational ArangoDB / Virtuoso and Salt tooling rows (Salt is Python — banned) with the consensus + formal-verification tooling that actually ships.

2 — EXPLAINME.adoc

  • New Reflexion receipts section (façade Phronesis.Reflexion.review/2, the REPORT-adequacy anchor example, JEG / equivalence / hash-chained ledger), all path-verified.
  • Wired the reflexion modules + docs/REFLEXION.adoc into the file map.

3 — RSR + standards compliance (humans and bots)

  • .machine_readable/ai/ — Cursor / Cline / Windsurf rules + AI.a2ml + README index, tailored to Phronesis (real languages, MPL-2.0 code + CC-BY-SA-4.0 docs split, no placeholders, no banned-language references).
  • .github/copilot-instructions.md — moved from the repo root (where Copilot never read it) and destaled (dropped ReScript, JavaScript → AffineScript, npm/yarn/pnpm → Deno, removed the self-contradictory "GitLab CI preferred" row).
  • AUDIT.adoc — honest claims-vs-reality ledger (what is real vs scaffold/roadmap).
  • .machine_readable/6a2/anchors/ANCHOR.a2ml — repo identity + golden path (just deps/build/test).
  • .machine_readable/root-allow.txt — canonical root allowlist.
  • 0-AI-MANIFEST.a2ml — point AI/bot instructions at .machine_readable/ai/ (the .bot_directives/ dir never existed); refresh the structure tree.
  • Stale cross-reference sweep across academic/, wiki/, IMPLEMENTATION-ROADMAP, GOVERNANCE, .claude/CLAUDE.md: proof-file refs .md.adoc; licence misstatements (Apache/MIT and AGPL → MPL-2.0 + CC-BY-SA-4.0); version banners 0.1.00.9.0; .scm.a2ml; Guile state-file row → A2ML; removed the SaltStack-Python exception.

4 — Root cleanup

  • Removed cruft: the committed 1.7 MB phronesis escript (now gitignored), ANALYSIS-COMPLETE.adoc (session artefact), the redundant root SPEC.core.a2ml symlink.
  • Relocated the estate *.toml configs to .machine_readable/configs/.
  • Moved internal status/design docs to docs/ (LSP summary, testing report, test-needs, toolchain wishlist, wokelang comparison) and orphaned root demo scripts to examples/.
  • adoc-first: converted the remaining estate .md docs to .adoc (CC-BY-SA-4.0) via pandoc — docs/CONSENSUS, docs/safety_proofs, docs/tech-debt-2026-05-26, deploy/DEPLOYMENT, spec/system-specs, editors/vscode/README, syntax/README. Only GitHub/tool-required Markdown remains.

The root is now reduced to 28 files, every one accounted for in root-allow.txt.

Metadata

  • STATE.a2ml: marked the suite green (last-result warn → pass), dropped the resolved test-failure blocker, bumped dates.

Note for review

The 7 converted docs were MPL-2.0 Markdown; their new .adoc files carry CC-BY-SA-4.0, consistent with the owner-authorised documentation-licence policy already applied to the sibling narrative docs. Flag if any of those should remain MPL-2.0.

🤖 Generated with Claude Code

https://claude.ai/code/session_01AqMopxUsgu78rg5fhWBUkk


Generated by Claude Code

claude added 4 commits June 20, 2026 05:04
…-references

README.adoc: version Standard-Candidate-1.0 -> 0.9.0 (matches mix.exs); correct
the probabilistic-types claim (runtime-represented, static checking on the
roadmap — not "statically checked"); add the reflexion design layer to the IP
table; replace the aspirational ArangoDB / Salt tooling rows (Salt is Python,
banned) with the consensus + formal-verification tooling that actually ships.

EXPLAINME.adoc: add a "Reflexion" receipts section (façade Phronesis.Reflexion,
anchor REPORT-adequacy example, JEG / equivalence / hash-chained ledger) and
wire the reflexion modules + docs/REFLEXION.adoc into the file map.

Stale cross-reference sweep (nothing pointing at the old layout):
- academic/theorem-index.adoc: lattice/game proof citations -> real .adoc paths
- academic/*: bulk .md -> .adoc proof references; white-paper wiki/docs refs
- academic/README.adoc: licence statement Apache-2.0/MIT -> CC-BY-SA-4.0
- wiki/Contributing.adoc: contribution licence AGPL-3.0 -> MPL-2.0 + CC-BY-SA-4.0;
  dead CONTRIBUTORS link -> MAINTAINERS.adoc
- wiki/{Quick-Start,Installation,CLI-Reference}.adoc: REPL/version banners 0.1.0 -> 0.9.0
- IMPLEMENTATION-ROADMAP.adoc: SPEC.core/META/ECOSYSTEM .scm -> .a2ml
- GOVERNANCE.adoc: CONTRIBUTING.adoc -> CONTRIBUTING.md (canonical file)
- .claude/CLAUDE.md: Guile .scm state files -> A2ML; drop removed SaltStack-Python
  exception (Python fully banned)

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AqMopxUsgu78rg5fhWBUkk
Bring the repo in line with the rsr-template-repo layout so both humans and
bots have sorted, accurate guidance:

- .machine_readable/ai/: Cursor/Cline/Windsurf rules + AI.a2ml + README index,
  all tailored to Phronesis (real languages Elixir/Rust/Idris2/Agda/Zig/TLA+,
  MPL-2.0 code + CC-BY-SA-4.0 docs split, no placeholders, no banned-language
  references).
- .github/copilot-instructions.md: moved from the repo root (where Copilot does
  not read it) and destaled — dropped ReScript from the language hierarchy,
  JavaScript now points at AffineScript, npm/yarn/pnpm -> Deno, removed the
  self-contradictory "GitLab CI preferred" row.
- AUDIT.adoc (root): honest claims-vs-reality ledger — what is real (lexer,
  parser, type checker, interpreter, LSP, reflexion, green suite) vs scaffold/
  roadmap (WASM compiler, Raft runtime, static probabilistic types, package
  registry, unreviewed proof corpus).
- .machine_readable/6a2/anchors/ANCHOR.a2ml: repo identity + golden path
  (just deps/build/test) + implementation policy.
- .machine_readable/root-allow.txt: canonical root allowlist (drift = anything
  at root not listed here).
- .machine_readable/configs/README.adoc: index for the relocated estate configs.
- 0-AI-MANIFEST.a2ml: point AI/bot instructions at .machine_readable/ai/ (the
  .bot_directives/ dir never existed); refresh the structure tree.

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AqMopxUsgu78rg5fhWBUkk
… AsciiDoc

Root cleanup so the tree matches .machine_readable/root-allow.txt (every root
entry is now accounted for):

Removed cruft:
- phronesis (1.7 MB compiled escript committed by accident; now gitignored)
- ANALYSIS-COMPLETE.adoc (one-off session artefact)
- SPEC.core.a2ml (root symlink redundant with .machine_readable/SPEC.core.a2ml)

Relocated machine-readable configs to .machine_readable/configs/:
- eclexiaiser.toml, k9iser.toml, opsm.toml, stapeln.toml (consumed by estate
  tooling, not mix/cargo)

Moved internal status/design docs out of the root into docs/:
- LSP-IMPLEMENTATION-SUMMARY, TESTING-REPORT, TEST-NEEDS, TOOLCHAIN-WISHLIST,
  WOKELANG-FEATURE-COMPARISON (refs in EXPLAINME/AUDIT/ANCHOR updated)

Moved orphaned root demo scripts to examples/:
- test_e2e.exs, test_framework_demo.exs, test_stdlib.exs (the ExUnit suite in
  test/ is the real coverage; these were never wired into CI)

adoc-first: converted the remaining estate .md docs to .adoc (CC-BY-SA-4.0 per
the documentation licence policy), via pandoc:
- docs/CONSENSUS, docs/safety_proofs, docs/tech-debt-2026-05-26,
  deploy/DEPLOYMENT, spec/system-specs, editors/vscode/README, syntax/README
Only GitHub/tool-required Markdown remains (.github/**, SECURITY.md,
CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md, .claude/CLAUDE.md).

No source code touched; docs/config/cruft only.

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AqMopxUsgu78rg5fhWBUkk
The pre-existing DebuggerTest/DocGeneratorTest/IncrementalLexerTest/Conformance
failures were fixed and merged; the ExUnit suite is green (consensus/Raft cases
skipped pending :ra). Update STATE.a2ml: last-result warn -> pass, drop the
resolved blocker and its next-action, bump dates to 2026-06-20, refresh the
session note.

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AqMopxUsgu78rg5fhWBUkk
@github-actions

Copy link
Copy Markdown

🔍 Hypatia Security Scan

Findings: 8 issues detected

Severity Count
🔴 Critical 0
🟠 High 3
🟡 Medium 5
View findings
[
  {
    "reason": "binary_to_term without :safe option -- deserialization attack (1 occurrences, CWE-502)",
    "type": "elixir_send_unsanitised",
    "file": "/home/runner/work/phronesis/phronesis/lib/phronesis/compiler.ex",
    "action": "flag",
    "rule_module": "code_safety",
    "severity": "high"
  },
  {
    "reason": "Nominal-only SAST in phronesis: codeql.yml language matrix contains no language present in the repo and lacks `actions`, so CodeQL records zero results on every commit. Remediation: set the CodeQL matrix to `language: actions`.",
    "type": "StaticAnalysis",
    "file": "/home/runner/work/phronesis/phronesis",
    "action": "auto_fix",
    "rule_module": "scorecard",
    "severity": "medium",
    "remediation": "Add CodeQL or equivalent SAST workflow.",
    "scorecard_check": "SAST"
  },
  {
    "reason": "Repository has 6 non-main remote branch(es). Policy: single main branch only.",
    "type": "GS007",
    "file": ".",
    "action": "delete_remote_branches",
    "rule_module": "git_state",
    "severity": "medium"
  },
  {
    "reason": "Code scanning (Hypatia): hypatia/structural_drift/SD007 -- Hypatia structural_drift: SD007 -- 8 day(s) old",
    "type": "CSA001",
    "file": ".claude/CLAUDE.md",
    "action": "review",
    "rule_module": "code_scanning_alerts",
    "severity": "medium"
  },
  {
    "reason": "Code scanning (Hypatia): hypatia/structural_drift/SD007 -- Hypatia structural_drift: SD007 -- 8 day(s) old",
    "type": "CSA001",
    "file": ".claude/CLAUDE.md",
    "action": "review",
    "rule_module": "code_scanning_alerts",
    "severity": "medium"
  },
  {
    "reason": "Code scanning (Hypatia): hypatia/structural_drift/SD007 -- Hypatia structural_drift: SD007 -- 8 day(s) old",
    "type": "CSA001",
    "file": ".claude/CLAUDE.md",
    "action": "review",
    "rule_module": "code_scanning_alerts",
    "severity": "medium"
  },
  {
    "reason": "Code scanning (Hypatia): hypatia/code_safety/elixir_send_unsanitised -- Hypatia code_safety: elixir_send_unsanitised -- 8 day(s) old [STALE]",
    "type": "CSA001",
    "file": "lib/phronesis/compiler.ex",
    "action": "escalate",
    "rule_module": "code_scanning_alerts",
    "severity": "high"
  },
  {
    "reason": "Code-scanning alert hypatia/code_safety/elixir_send_unsanitised (high) at lib/phronesis/compiler.ex is 8 days old (threshold: 7 days) -- overdue for remediation",
    "type": "CSA003",
    "file": "lib/phronesis/compiler.ex",
    "action": "escalate",
    "rule_module": "code_scanning_alerts",
    "severity": "high"
  }
]

Powered by Hypatia Neurosymbolic CI/CD Intelligence

@hyperpolymath
hyperpolymath marked this pull request as ready for review June 20, 2026 06:48
@hyperpolymath
hyperpolymath merged commit 3ad0d72 into main Jun 20, 2026
9 checks passed
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.

2 participants