Skip to content

docs: add an agent guide (AGENTS.md), with CLAUDE.md pointing to it - #30

Merged
ohdearquant merged 7 commits into
mainfrom
docs/agent-guides
Aug 17, 2026
Merged

docs: add an agent guide (AGENTS.md), with CLAUDE.md pointing to it#30
ohdearquant merged 7 commits into
mainfrom
docs/agent-guides

Conversation

@ohdearquant

Copy link
Copy Markdown
Owner

Adds AGENTS.md: the short contract a coding agent must not break when working in this repository — the rules that bind every change (artifact-before-claim, immutable measurements, what the numbers mean and do not mean, abstention as an output, fail-closed paths, frozen policy), the build/test commands, the generated-file table, where each versioned contract is decided, decision-record discipline, and style.

CLAUDE.md is deliberately a pointer to AGENTS.md rather than a second copy, so the two cannot drift; it repeats only the two facts most often needed before a first edit (the verify commands and the viewer/dist-static byte-identity rule).

No code changes. Content is derived from CONTRIBUTING.md, INTERFACES.md, the decision records, and .github/workflows/ci.yml, and links to them rather than restating detail.

khive and others added 7 commits August 17, 2026 09:16
The table pointed every bridge at a matching *:write script, but the
Firefly bridge has no such script, and validators:write emits only the
.mjs, not the adjacent declaration. Each row now names the command that
actually reproduces its artifact.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The build chain checks the validators module and two of the three
bridges; the pixel-rag bridge check exists but is wired to nothing, and
the validators declaration has no drift check. Saying every artifact is
check-gated invited hand edits in exactly the two unprotected spots.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The write scripts take required arguments and the Firefly viewer module
is check-only; the bare commands in the table exited at argument parsing
without writing anything. Each row now shows the working invocation and
points at the doc that explains it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… regenerable at will

The projection script reads .cache measured-run inputs absent from the
repository and refuses to overwrite an existing bridge file, so the
regeneration row now points at a fresh --write path and a note explains
when regeneration is possible at all.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The script reads .cache/showcase-firefly-v1/ and
.cache/showcase-firefly-khive-v1/evidence/; the previous wording matched
only the first.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ohdearquant
ohdearquant merged commit e1a8140 into main Aug 17, 2026
3 checks passed
@ohdearquant
ohdearquant deleted the docs/agent-guides branch August 17, 2026 17:32
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