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

Codebase Conventions

Crate naming

LayerRuleExample
Folder (crates/<name>/)Single word, lowercasecrates/mcphost/
Package namebrainos-<word>brainos-mcphost
Workspace aliasSingle word, matches foldermcphost = { workspace = true }
Rust importbrainos_<word>use brainos_mcphost::RmcpHost;

Workspace deps

  • All internal crates declared in root [workspace.dependencies]
  • Consumers always use <name> = { workspace = true }
  • Workspace version locked across all crates

Comments + docs

  • No internal labels (Phase / PR references) in source code
  • No stale feature references in docs
  • PR memos and commit messages may use internal labels freely

CI parity

Every push runs: cargo fmt --all --check + cargo clippy --workspace --all-targets -- -D warnings + cargo test --workspace + cargo check --workspace --no-default-features.