Grob Documentation

Start here: Documentation Index

Tutorials (learning-oriented)

• Getting Started -- Install, configure, and run Grob end-to-end
• Quick Start -- Condensed version for experienced users

How-to Guides (task-oriented)

• How to Configure Grob -- Budgets, fallbacks, routing rules, tracing
• How to Deploy Grob -- Containers, Kubernetes, systemd, monitoring
• How to Contribute -- Development workflow, code style, CI
• Provider Setup -- Per-provider configuration
• OAuth Setup -- OAuth for Anthropic Pro/Max and Gemini Pro
• Troubleshooting -- Common errors and fixes

Reference (information-oriented)

• Configuration Reference -- All TOML config options
• CLI Reference -- All commands and flags
• Error Reference -- HTTP status codes and error types
• OpenAI Compatibility -- /v1/chat/completions endpoint
• OpenAPI Specification -- Full API in OpenAPI 3.0

Explanation (understanding-oriented)

• Architecture -- Request flow, module layout, design decisions
• Design Principles -- Philosophy and UX guidelines
• Security Model -- Threat model, defense layers, TLS
• Gemini Integration -- Gemini and Vertex AI specifics
• Architecture Decision Records -- ADRs for key design choices

Monitoring

Grob exposes Prometheus metrics at /metrics. A Grafana dashboard is provided in grafana-dashboard.json.

Documentation Completeness

See DCI-REPORT.md for the Documentation Completeness Index with scores, gaps, and improvement recommendations.