Login
Which document holds what
Login

Generated from knowledge-map.json by crystal run spec/support/generate.cr; edit that file, not this one. Which document holds what, so each topic is written in one place and the others link to it. spec/guards/delineation_spec.cr holds every document of the tree to this map; records kept outside the tree are listed under elsewhere, and new test records go in Fossil tech-notes, linked from here; docs/knowledge-map.md is generated from it.

Why OCX exists

Document Answers Holds Kind
README.md What is OCX, and what governs it? the axioms; the virtues; the building blocks: Fossil, Crystal, Linux; where the release is served guide
KEEP.md What has the maintainer said to keep? the maintainer's standing directions, verbatim guide
PLAN.md What is OCX for, what guards it, and what is still missing? the objective; the precepts with their README virtues; where each function stands; how each kind of agent works on protocol v1: hosted agents, the native agent for local models, an agent's MCP surface, and agents that cannot hold a key; the parity contract; the phases; the working rules; open design questions guide
ROADMAP.md Where is each building block headed beyond this project? the building blocks' direction guide
HISTORY.md What was decided, and why? where OCX came from; the numbered decisions record: add a decision; never rewrite one

The words and the map

Document Answers Holds Kind
GLOSSARY.md What does a word mean here? the project's words guide
ARCHITECTURE.md How do OCX's parts fit its purpose? OCX's layers and their state; how the parts are arranged guide
knowledge-map.json Which document holds what? which document holds each topic data
docs/knowledge-map.md Which document holds what, to read? generated: generated from knowledge-map.json

Using OCX

Document Answers Holds Kind
SCENARIOS.md How do I use OCX for a goal, and does each step work yet? the maintainer's scenarios and the state of each step guide
USAGE.md What does each tool take and answer? each tool's inputs and answers; patterns and how to write one; installing a node and the hook guide
AGENTS.md How does an agent work in this repository? an agent's workflow in its workspace; the check-in comment's form guide
docs/invite.md How does an invited agent join? an invited agent's steps guide

Protocol v1

Document Answers Holds Kind
docs/protocol-v1.md What does protocol v1 define, what is it for, and what stays stable? what protocol v1 is for; the message kinds and their layers; values; the workspace, sandbox, limits and process layers; subscriptions and delivery guarantees; a run's life; refusals; ended's outcomes; the protocol's words; stability: what may be added and what never changes definition
docs/protocol-v1-fossil.md What does protocol v1 rest on? Fossil as the medium; finding a message in an artifact; who sent an artifact, and who may do what; nodes: on the server and on other hosts; versions definition
docs/protocol-v1-verdicts.md How is a verdict written and counted? writing and reading verdicts definition
docs/protocol-v1-tools.md Which of OCX's tools write protocol v1's artifacts? the tools for protocol v1 and where each is offered definition
docs/protocol-v1-examples.md What do whole messages look like? example messages with what a node writes back definition
docs/protocol-v1-failures.md What comes of each failure or race? the failure cases, numbered for the specs definition

Building OCX

Document Answers Holds Kind
docs/parity-v1.md What did trunk do that ocx2 lacks, and in what order is it built? parity with trunk and the order to build guide
docs/backlog.md What has been raised but not yet decided? ideas awaiting the maintainer's review guide
docs/interfaces.md Exactly what does each interface do, and which spec shows it? each interface's behavior and its specs guide
docs/crystal.md How is OCX's Crystal written? the rules for Crystal code guide
docs/fossil.md What has been learned about Fossil? lessons about Fossil guide
docs/linux.md What has been learned about Linux? lessons about Linux guide

What the code is made of

Document Answers Holds Kind
docs/design/modules.json What is each module of src/ for? each module's purpose and layer data
docs/design/modules.md What is each module of src/ for, to read? generated: generated from docs/design/modules.json
docs/survey/functionality.json Which behavior does each file and spec serve? each behavior with its parts and specs data
docs/survey/gaps.json Which survey gaps are known? the survey's known gaps data
docs/design/facts.json Which Fossil settings does the code read? the Fossil settings OCX reads data
docs/precepts/precepts.json Which precepts do the guards hold? the guarded precepts data
docs/precepts/gaps.json Which precepts lack a guard, a refutation or a CI run? the precepts' known gaps data
docs/precepts/exceptions.json What is excepted from a precept, and why? the precepts' exceptions data
docs/precepts/pace.json How long may the gate take? the gate's time limit data

Records

Document Answers Holds Kind
docs/slices.md How was the rebuild first sliced? the rebuild's first slices record: kept as it stood
docs/slices-parity.md How was parity with the ocx release first built? the first parity slices record: kept as it stood
docs/slices-git.md How was the git round trip built? the git round-trip slices record: kept as it stood
docs/slices-v1.md How was protocol v1 first built? protocol v1's first slices record: kept as it stood
docs/review-v1.md What did the review of 2026-10-12 and 13 find? the review of v1 record: kept as it stood
docs/review-v1-tables.md What did the review of the tables draft find? the review of the tables draft record: kept as it stood

Records kept elsewhere

Kinds