docs: agent notes for this repository and for its consumers

AGENTS.template.md is what crafter-build writes AGENTS.md from on every
build and test run: the partition map, the toolchain facts the code
leans on, build and test commands, test conventions, code style, the
design rules with their reasons, commit guidelines and the gotchas
found in the storage and file layers. AGENTS.consumer.md is the section
crafter-build copies into the AGENTS.md of every project that depends
on this library: declaring the dependency, the table-struct rules,
locking and durability, writing and querying, migrations, an errors
table and how to test a consumer.

Both were fact-checked claim by claim against the interfaces, the
implementation units and the tests. AGENTS.md is build output and is
now gitignored, as in the sibling libraries.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
Jorijn van der Graaf 2026-10-31 20:51:14 +01:00
commit 38c9076e1d
Signed by: jorijnvdgraaf
GPG key ID: 2937E59CDCC1BCFB
3 changed files with 238 additions and 0 deletions

2
.gitignore vendored
View file

@ -1,2 +1,4 @@
build/
bin/
# written by every build and test run from AGENTS.template.md
/AGENTS.md