Skip to main content

Foundational Documents

The paddles repository contains a stack of markdown documents that define the project's architecture, philosophy, and operational commitments. This page explains the reading order and what each document covers.

Reading Order

OrderDocumentWhat it covers
1AGENTS.mdOperator guidance and the top-level working contract for agents
2INSTRUCTIONS.mdThe canonical Keel turn loop and procedural checklists
3README.mdBackbone architecture narrative, current capabilities, growing edges, and the high-level steering-signal map
4CONSTITUTION.mdCollaboration philosophy, environmental calibration, and core invariants
5POLICY.mdOperational commitments: boot invariants, zero drift, model routing, steering-signal guarantees, mission criteria
6ARCHITECTURE.mdTurn loop narrative, implementation map, context architecture, recorder boundary, and the detailed steering-signal taxonomy
7PROTOCOL.mdCommunications protocol, message format, routing rules
8CONFIGURATION.mdConcrete lane and runtime configuration reference

Supplementary References

DocumentWhat it covers
CODE_WALKTHROUGH.mdSource layout, key abstractions, data flows, where-to-look table
STAGE.mdVisual philosophy for scene-based CLI output
RELEASE.mdVersioning and release process
.keel/adrs/Binding architecture decision records

Decision Hierarchy

The reading order is not the decision hierarchy. When documents disagree:

  1. ADRs (binding decisions)
  2. CONSTITUTION (philosophy and invariants)
  3. POLICY (operational commitments)
  4. ARCHITECTURE (implementation contracts)
  5. Current planning artifacts (missions, epics, stories)

Pressure Reading Route

If you specifically want to understand how Paddles applies steering signals inside the harness, read these in order:

  1. README.md for the high-level steering-signal families
  2. POLICY.md for the binding controller commitments
  3. ARCHITECTURE.md for the detailed runtime taxonomy, influence snapshots, and the boundary between the forensic inspector and the metaphorical manifold route
  4. Steering Signals for the public-facing explanation, including the manifold route and its accountability limits
  5. Recursive Planning for how steering signals change planner behavior