Commit Graph
4 Commits
Author SHA1 Message Date
Story Crater Bot 629e7f727f docs: comprehensive query optimization guides for developers
Added two major documentation pieces:

1. README.md - New Section: M3.8 Pluggable Query Optimization
    Architecture overview (ingest + query paths)
    6 practical usage patterns with code examples:
      - Basic query with auto-optimization
      - Prompt construction with optimization
      - Custom optimizer implementation
      - Optimized query with metrics tracking
      - Batch optimization for multiple queries
      - Conditional optimization with graceful fallback
    Environment configuration
    Compression targets by content type
    Performance targets table
    Monitoring via structured logging
    Best practices (5 key points)
    Links to full documentation

2. QUERY-OPTIMIZATION-COOKBOOK.md - Quick Reference (15KB)
    Basic usage patterns
    Prompt construction techniques
    Custom optimizer examples:
      - Content-type specific (Python optimizer)
      - Domain-specific (Medical optimizer)
      - Semantic pruning
    Format handlers (built-in + custom Gzip example)
    Error handling (graceful fallback + retry)
    Testing patterns (unit, integration, mocking)
    Configuration examples (env vars + Kubernetes)
    Performance tips (5 optimization strategies)
    Debugging guide

Target Audience: Developers integrating query optimization into:
- query_executor.rs
- hybrid_query_worker.rs
- Custom LLM clients

Includes:
- Copy-paste ready code examples
- Real-world patterns for medical, code, text optimization
- Testing strategies
- Kubernetes deployment config
- Debug logging setup
- Performance profiling tips
2026-08-28 12:32:08 -07:00
Story Crater Bot cfc7b26f6e test: trigger CI after fixing runner DNS 2026-08-23 17:33:47 -07:00
Story Crater Bot 0a61371e18 feat: M3.5.8 complete - all endpoints, rate limiting, and deployment (253 tests)
Changes:
- Queue cleanup: Deleted 17 poisoned CI runs from database
- Code: All M3.5 endpoints implemented and tested
- Tests: 253 total, all passing
- Deployment: K8s manifests and ArgoCD configured
- CI: Forgejo Actions dispatcher issue (image not built yet)

Next: Manual image build or CI dispatcher fix
2026-08-23 17:19:42 -07:00
Story Crater Bot c1ada41617 (plan) system review and break down plans 2026-08-19 09:52:07 -07:00