The documentation
Every document in the repository, rendered from the file of the same name. Three of them are generated from the source by make docs, and make check fails the build when they go stale — so those three cannot drift from the code they index.
docs/TOUR.md — sixteen steps, about an hour
Sixteen numbered steps — twenty-two stops, counting 6b, 7b, 7c, 8b, 8c and 13b — about an hour. Steps 1–7 are the complete answer to "what is OpenEnv"; everything after them is how a server that has to survive strangers is built underneath it.
Step one of the tour is this repository's README, and the whole of it is here.
The protocol
docs/PROTOCOL.md | our statement of the protocol. The sixteen routes, the five and four message types, the envelope, the seven error strings |
docs/NOT-THE-PROTOCOL.md | what a conforming OpenEnv implementation does not have to do, with the reference's own captured bytes beside each claim |
docs/WARTS.md generated | every WART-nn with its four lines verbatim, plus the CONF-nn citations — twenty-five of them, covering the twenty-three numbered server requirements |
docs/GAPS.md generated | every GAP-nn with its three lines verbatim — the places where the protocol turns out not to exist |
docs/BOUNDARY.md generated | every [WIRE]/[SDK]/[POLICY] tag with its symbol and site, then every SAFETY: line. Two boundaries, one index |
Those five are one subject from five sides, and every one of them carries a rail to the other four: what it is, what it is not, where the reference is an accident, where the protocol is silent, and which names are protocol and which are ours.
The models, once each
docs/MEMORY.md | the arena model, the one rule an author carries, and the three antidotes to the hazard it creates |
docs/ERRORS.md | one flat enum, why none of its names ever reaches a peer, and the collapse onto what one does |
docs/SECURITY.md | the threat model, every cap and why that number, and two limits that were wrong |
docs/PORTING.md | the one file with platform conditionals in it, and what a port has to keep true |
Shipping it, and breaking it
docs/PACKAGING.md | install, pkg-config, vendoring, embedding, and the container |
docs/FUZZING.md | the six fuzz targets, their invariant oracles, and Autobahn case by case |
docs/TRAINING.md | how to train a small language model on the arcade's environments jointly, with rewards the environments themselves compute |
arcade/MATH.md | Eight small environments turn mathematics into ordinary text, then grade the answer with ordinary code. |
The evidence
docs/PROVENANCE.md | No upstream code is vendored in this repository. Not a line. That is the first thing to establish, because it is the thing that makes everything else here worth reading |
docs/evidence/OBSERVED-WIRE.md | captured traffic, byte for byte |
docs/evidence/REFERENCE-NOTES.md | where each measured constant came from |
docs/CONFORMANCE.md | the machine-readable verdict for every exchange in the captured reference corpus |
The directories
Each of these is a directory's own README, and each opens with a claim you can check with one command.
src/README.md | the layers, and the line the whole repository is about |
src/wire/README.md | the plumbing does not know what it is carrying |
src/proto/README.md | the protocol, and no way to reach a socket from here |
src/server/README.md | hosting the protocol |
src/client/README.md | driving the protocol from the other end |
envs/README.md | what an environment author actually writes |
arcade/README.md | games, synthesis tasks, and text-first mathematics |
examples/README.md | the other end of the socket |
tests/README.md | read them; they are the specification |
tests/embed/README.md | can a stranger consume this? |
tour/README.md | the protocol, hand-written, from both chairs |