docs: state write-up for humans and machines; make the golden path real - #148
Conversation
… path real The README documented `just build` / `just test` as the quickstart, but the Justfile was PARSE-DEAD — a `//` C-style comment on line 2 made `just` reject the whole file (`error: unknown start of token '.'`), so no recipe was reachable; and every recipe was an `@echo` stub anyway. `just verify` checked a `.machine_read/` path that has never existed and swallowed failures with `||`, so it always claimed success. Justfile: real cargo recipes (build/test/lint/fmt/check/proofs/pipeline), split `-all` variants for the LLVM-dependent crate, and a `verify` that exits non-zero when a path is missing. Parse- and run-verified: `just build` exits 0, `just test` reports 221 passing / 0 failing. STATE.a2ml (machines): version 0.1.0 -> 0.2.0 to match Cargo.toml; current session + maintenance status; a new [security-posture] section distinguishing EXPIRING baseline debt from PERMANENT scoped exemptions, with the three active exemptions and their rule-precision rationale, plus upstream rule-fix candidates; a [toolchain] section; the my-llvm/LLVM-21 local limitation recorded so a bare workspace build failure is not misread as a regression; and the dialect model corrected from four co-equal surfaces to solo ⊂ duet ⊂ ensemble with me as an outside projector. README (humans): quickstart now matches reality incl. the my-llvm caveat; dialect containment; measured test count (137+ -> 221); governance/security posture; `.machine_readable/` and `_exploratory/` documented, and the `contractiles/` path corrected (it is not at the repo root). CHANGELOG: Security / Fixed / Changed entries for #143, #146, #147. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Note Automatic reviews are paused because your trial's included automatic processing has been used for this period. Upgrade now, or comment "Gitar review" to run a review anytime. Code Review ✅ ApprovedDocumentation updates that fix parse-dead Justfile recipes, update the machine-readable state manifest, and align the README quickstart with reality. No issues found.
OptionsDisplay: compact → Showing less information. Comment with these commands to change the behavior for this request:
Was this helpful? React with 👍 / 👎 | Gitar |
|
|
![gitar-bot[bot]](https://avatars.githubusercontent.com/in/827041?s=60&v=4){kind=small}
1 participant
Closes out the my-lang session by recording current state in-repo (not only in dev-notes) and fixing the documentation defects found while doing it.
The Justfile was parse-dead
README.mddocumentedjust build/just testas the quickstart. Neither worked: a//C-style comment on line 2 madejustreject the entire file (error: unknown start of token '.'), so no recipe was reachable — and every recipe was an@echostub regardless.just verifychecked.machine_read/(a path that has never existed) and swallowed every failure with||, so it always reported success.Now: real cargo recipes,
-allvariants for the LLVM-dependent crate, and averifythat exits non-zero. Verified by running them —just buildexits 0;just testreports 221 passing, 0 failing.(Estate note: 143 of 751 Justfiles across the estate are parse-dead by the same class of defect — 76× unindented shell blocks, 35×
//comments, 32×Justfile/justfilecase collisions. Out of scope here; recorded in dev-notes.)For machines —
.machine_readable/6a2/STATE.a2ml0.1.0→0.2.0(was drifting fromCargo.toml)[security-posture]: distinguishes expiring baseline debt (7 entries → 2026-10-27, Reduce panic surface: unwrap/expect debt flagged by hypatia (baselined 2026-07-27) #145) from permanent scoped exemptions (3, each a rule-precision problem), plus upstream rule-fix candidates[toolchain];known-local-limitationrecords thatmy-llvmneeds system LLVM 21, so a bare workspace build failure is not misread as a regressionmean outside projector — not four co-equal surfacessuperseded-branchrecords the evidence thatfeat/stdlib-fs-env-formatis safe to deleteFor humans — README + CHANGELOG
Quickstart matches reality (incl. the my-llvm caveat); dialect containment; measured test count (137+ → 221); governance/security posture;
contractiles/path corrected (it is under.machine_readable/, not the repo root). CHANGELOG gains Security/Fixed/Changed entries for #143, #146, #147.🤖 Generated with Claude Code