Build, configuration, logging, troubleshooting, reporting, and error handling guides
Quick Reference: Pipeline Orchestration | Troubleshooting | Logging | Configuration
| Sub-directory | Purpose | Key Files |
|---|---|---|
build/ |
Build system, dependencies, CI/CD | README.md, build-system.md, dependency-management.md, ci-cd-integration.md |
config/ |
Configuration, checkpoints, performance | configuration.md, checkpoint-resume.md, performance-optimization.md |
logging/ |
Logging system (Python, Bash, patterns) | README.md (full guide), python-logging.md, bash-logging.md |
troubleshooting/ |
Issue resolution and recovery | README.md (flowchart), common-errors.md, llm-review.md |
| Guide | Description |
|---|---|
| reporting-guide.md | Pipeline reporting system and report interpretation |
| error-handling-guide.md | Error handling patterns and custom exceptions |
| Need | Go to |
|---|---|
| Pipeline stages and commands | ../RUN_GUIDE.md |
| Build / uv / lockfiles | build/ |
| CI/CD automation | ../../.github/README.md |
| Fix a build error | troubleshooting/ |
| Configure logging | logging/ |
| System configuration | config/configuration.md |
| Resume a failed pipeline | config/checkpoint-resume.md |
| Optimize performance | config/performance-optimization.md |
| First time setup? | config-wizard.md · CLAUDE.md |
| Deploy with Docker? | docker.md |
| Incident response? | runbook.md |
| Routine maintenance? | maintenance.md |
- Architecture — System design overview
- Common Workflows — Step-by-step recipes
- FAQ — Common questions
- Overview — High-level overview of operations documentation
- Diagrams — Architecture and workflow diagrams
Migrated from
operations/README.md