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.).