Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Engineering guide

Rust conventions for Flock contributors. Guardrail enforcement lives in governance policies.

Toolchain

  • Pin via rust-toolchain.toml
  • Format: cargo fmt --all
  • Lint: cargo clippy --workspace --all-targets -- -D warnings

Verification

./scripts/verify.sh
flock drift-check

Crate boundaries

CrateResponsibility
flock-coreTypes: Goal, EpisodeLog, topology
flock-runtimeScheduler, engine, MCP hot path
flock-eventsUnified observability schema
flock-cliOperator surface
flock-multiplexerPTY + socket API

Docs

  • Book is canonical public docs (book/src/)
  • docs/ holds specs and staging; do not link GitHub blobs from book pages