Skip to content

docs(integration): Add Part 2 - integration scenarios and configuration#342

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-335-integration-guide-part-2-integration-scenarios-and
Feb 8, 2026
Merged

docs(integration): Add Part 2 - integration scenarios and configuration#342
kcenon merged 1 commit into
mainfrom
docs/issue-335-integration-guide-part-2-integration-scenarios-and

Conversation

@kcenon

@kcenon kcenon commented Feb 8, 2026

Copy link
Copy Markdown
Owner

Closes #335

Summary

This PR adds Part 2 of the cross-system integration guide, covering:

  • 4 Integration Scenarios with complete code examples:

    1. Web API Server: HTTP REST API with async handling (common + thread + logger + network)
    2. Data Pipeline: ETL with batch processing (common + thread + database + container)
    3. Monitoring Stack: Metrics and health checks (common + thread + monitoring + logger)
    4. Full Stack: Production app using all 7 systems
  • Configuration Management Across Systems:

    • Unified YAML configuration strategy
    • Hierarchical structure (common + system-specific)
    • Environment variable overrides
    • Per-scenario configuration examples
    • Validation patterns

Changes Made

  • Extended docs/INTEGRATION_GUIDE.md from 604 to 1463 lines (+859 lines)
  • Added Section 3: Common Integration Scenarios
    • 4 complete scenarios with 50-100 line code examples each
    • Configuration templates for each scenario
    • Common pitfalls and solutions tables
  • Added Section 4: Configuration Across Systems
    • Unified configuration schema
    • Shared vs system-specific settings
    • Environment variable mapping guide
    • Configuration validation examples
  • Updated Table of Contents
  • Updated document status (Part 1 → Parts 1-2 Complete)
  • Updated document version (1.0.0 → 2.0.0)

Test Plan

  • Document builds correctly (Markdown syntax valid)
  • Code examples compile (verified against existing headers)
  • YAML configuration examples are valid
  • All 4 scenarios cover required systems accurately
  • Configuration examples match scenario requirements
  • Links in Table of Contents work correctly
  • Related documentation links are valid

Next Steps

Part 3 (#336) will be implemented in a separate PR:

  • Error code ranges by system
  • Cross-system error propagation
  • Complete 100-line multi-system example
  • CMakeLists.txt setup for multi-system projects
  • Initialization/shutdown sequence with timeout handling
  • Korean translation

Extend integration guide with comprehensive scenarios:

Section 3: Common Integration Scenarios
- Scenario 1: Web API Server
  - Systems: common + thread + logger + network
  - HTTP REST API with async request handling
  - Structured logging and thread pool usage
  - 80-line code example with routing

- Scenario 2: Data Pipeline
  - Systems: common + thread + database + container
  - ETL pipeline with batch processing
  - JSON serialization and database integration
  - Parallel batch transformation example

- Scenario 3: Monitoring Stack
  - Systems: common + thread + monitoring + logger
  - Prometheus metrics, health checks
  - Periodic metric collection
  - Circuit breaker patterns

- Scenario 4: Full Stack Application
  - All 7 systems integrated
  - Production-ready web app
  - Complete dependency injection
  - Graceful shutdown handling

Section 4: Configuration Across Systems
- Unified configuration strategy
- Hierarchical YAML structure
- Shared vs system-specific settings
- Environment variable mapping
- Configuration validation patterns
- Per-scenario configuration examples

Document expanded from 604 to 1463 lines (+859 lines).

Part of: #335
@kcenon kcenon merged commit d492c9a into main Feb 8, 2026
24 checks passed
@kcenon kcenon deleted the docs/issue-335-integration-guide-part-2-integration-scenarios-and branch February 8, 2026 07:46
kcenon added a commit that referenced this pull request Apr 13, 2026
…on (#342)

Extend integration guide with comprehensive scenarios:

Section 3: Common Integration Scenarios
- Scenario 1: Web API Server
  - Systems: common + thread + logger + network
  - HTTP REST API with async request handling
  - Structured logging and thread pool usage
  - 80-line code example with routing

- Scenario 2: Data Pipeline
  - Systems: common + thread + database + container
  - ETL pipeline with batch processing
  - JSON serialization and database integration
  - Parallel batch transformation example

- Scenario 3: Monitoring Stack
  - Systems: common + thread + monitoring + logger
  - Prometheus metrics, health checks
  - Periodic metric collection
  - Circuit breaker patterns

- Scenario 4: Full Stack Application
  - All 7 systems integrated
  - Production-ready web app
  - Complete dependency injection
  - Graceful shutdown handling

Section 4: Configuration Across Systems
- Unified configuration strategy
- Hierarchical YAML structure
- Shared vs system-specific settings
- Environment variable mapping
- Configuration validation patterns
- Per-scenario configuration examples

Document expanded from 604 to 1463 lines (+859 lines).

Part of: #335
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant