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

Documentation style

Guidelines for Flock book pages.

Voice

  • Honest scope — say what Flock is not early
  • Operator-first — copy-paste commands that produce visible artifacts
  • No placeholder social proof

Formatting

  • One H1 per page (mdbook enforces)
  • Use > **Note** / > **Warning** admonitions
  • Mermaid diagrams: no inline style fill:#... (breaks dark mode)
  • Max 3 columns in comparison tables
  • Relative book links only — never link to raw GitHub docs/ blobs from book pages
  • Cross-link concepts ↔ reference ↔ integrations

Brand tokens

See book/theme/css/custom.css for Flock palette (--flock-runtime, --flock-substrate, etc.).

Harness capability docs

  • Single source: docs/harness-manifest.toml drives docs/HARNESS_FEATURES.md and the landscape table in docs/COMPETITIVE_MATRIX.md.
  • Update workflow: edit the manifest, then cargo run -p harness-docs -- generate.
  • CI: ./scripts/check-harness-doc-parity.sh (via verify.sh smoke-docs) fails on drift.