User Guide¶
In-depth reference documentation for BigBrotr's architecture, services, configuration, database, and monitoring.
Sections¶
| Page | Description |
|---|---|
| Architecture | Diamond DAG layer structure, design patterns, concurrency model, and testing architecture |
| Services | Deep dive into the six independent services: Seeder, Finder, Validator, Monitor, Synchronizer, Refresher |
| Configuration | Complete YAML configuration reference with Pydantic validation and examples |
| Database | PostgreSQL schema, stored functions, materialized views, and indexes |
| Monitoring | Prometheus metrics, alerting rules, Grafana dashboards, and structured logging |
Quick Navigation¶
- New to BigBrotr? Start with Architecture for the system overview, then Services to understand what each service does.
- Deploying? See Configuration for YAML reference and Monitoring for observability setup.
- Working on the database? See Database for schema details and stored function signatures.
Related Documentation¶
- Getting Started -- Installation and quick start
- How-to Guides -- Task-oriented guides
- API Reference -- Auto-generated API documentation