Skip to content

[Task] docs: Integration guide - Part 2: Integration scenarios and configuration #335

Description

@kcenon

Summary

Create the second part of the cross-system integration guide, covering common integration scenarios and configuration management across systems.

Parent Issue

Part of: #329

Dependencies

Blocked by: #334 (Part 1 must be completed first)

Scope (What)

Continue docs/INTEGRATION_GUIDE.md with the following sections:

3. Common Integration Scenarios

Document at least 4 integration scenarios with code examples:

Scenario Systems Key Config
Web API Server common + thread + logger + network HTTP facade + async logger
Data Pipeline common + thread + database + container Async DB + typed containers
Monitoring Stack common + thread + monitoring + logger Metrics + structured logging
Full Stack All 7 systems Complete bootstrapper setup

For each scenario:

  • Required systems and their roles
  • Configuration template
  • Code example (50-100 lines)
  • Common pitfalls and solutions

4. Configuration Across Systems

Document unified configuration strategy:

  • Per-system configuration sections
  • Shared settings (thread pool sizes, log levels, timeouts)
  • System-specific overrides
  • Configuration validation and defaults
  • Environment variable mapping

Example structure:

common:
  thread_pool_size: 8
  log_level: info

network:
  http_port: 8080
  connection_timeout: 30s

database:
  pool_size: 10
  query_timeout: 5s

Acceptance Criteria

  • At least 4 integration scenario examples documented
  • Each scenario includes code example and configuration
  • Unified configuration structure documented
  • Shared vs. system-specific settings explained
  • Configuration validation strategy documented

Deliverables

  • docs/INTEGRATION_GUIDE.md (Sections 3-4)
  • Configuration examples for each scenario

Metadata

Metadata

Assignees

Labels

architectureArchitectural changes and designdocumentationImprovements or additions to documentationpriority:highHigh priority issue

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions