Skip to content

[Task] docs: Integration guide - Part 1: Dependency map and integration patterns #334

Description

@kcenon

Summary

Create the first part of the cross-system integration guide, covering the ecosystem dependency map and core integration patterns.

Parent Issue

Part of: #329

Scope (What)

Create docs/INTEGRATION_GUIDE.md with the following sections:

1. Ecosystem Dependency Map

Document all 7 kcenon ecosystem systems with their dependency hierarchy:

common_system (Tier 0 - Foundation)
    ├── thread_system (Tier 1)
    │   ├── logger_system (Tier 2)
    │   │   └── database_system (Tier 3)
    │   └── monitoring_system (Tier 2, Rust)
    ├── container_system (Tier 1)
    └── network_system (Tier 2)

Include:

  • Visual dependency tree
  • Tier-based initialization order
  • Dependency rationale for each system

2. Integration Patterns

Document two main integration approaches:

Using unified_bootstrapper

auto system = unified_bootstrapper::create()
    .add<thread_system>()
    .add<logger_system>()
    .add<database_system>()
    .add<network_system>()
    .configure(config)
    .bootstrap();

Manual Adapter Wiring

  • typed_adapter for cross-system connections
  • Service container registration
  • Lifecycle management patterns

Acceptance Criteria

  • Dependency map with all 7 systems documented
  • Tier-based initialization order explained
  • Bootstrapper usage pattern documented with code example
  • Manual adapter wiring pattern documented
  • Service container integration explained

Deliverables

  • docs/INTEGRATION_GUIDE.md (Sections 1-2)
  • Code examples for both integration patterns

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