Code Style Guide¶

Overview¶

Ralph Orchestrator follows Rust community conventions with project-specific additions.

Rust Style¶

• Follow Rust API Guidelines
• Use cargo fmt for formatting
• Use cargo clippy for linting

Pre-commit Hooks¶

# Install hooks
./scripts/setup-hooks.sh

# Hooks run automatically on commit (CI parity):
# - ./scripts/sync-embedded-files.sh check
# - cargo fmt --all -- --check
# - cargo clippy --all-targets --all-features -- -D warnings
# - cargo test

Documentation Style¶

• Use present tense ("adds" not "added")
• Keep lines under 100 characters
• Include examples for public APIs
• Keep plugins.llmstxt.sections in mkdocs.yml in sync with docs IA changes
• Validate llms map changes with mkdocs build --strict and python scripts/validate_llms_txt.py site/llms.txt

See Also¶

• Development Setup - Environment setup
• Testing - Test guidelines
• Submitting PRs - PR process