What
Add 10 missing examples covering uncovered public API headers and split 5 oversized documentation files (42-75KB) for improved readability. Standardize README section ordering.
Current State
- Examples: 5 examples for 50+ public headers — critical coverage gap
- Oversized docs: 5 files exceed 30KB (PRODUCTION_GUIDE 75KB, INTEGRATION_GUIDE 73KB, CONFIG_GUIDE 54KB, FEATURE_FLAGS_GUIDE 48KB, FEATURES 42KB)
- README: Quick Start section appears after Requirements (should be before)
Why
As the Tier 0 foundation library, common_system's patterns (DI, EventBus, CircuitBreaker, Config) are used by all 7 downstream systems. Without examples for these core APIs, users cannot understand the patterns that the entire ecosystem depends on. Oversized docs (up to 75KB) are difficult to navigate and discourage reading.
How
A. New Examples (10 additions, 5→15)
| # |
Example |
Covers |
| 1 |
DI service container |
di/service_container.h, di/unified_bootstrapper.h |
| 2 |
Event bus pub/sub |
patterns/event_bus.h |
| 3 |
Circuit breaker |
resilience/circuit_breaker.h |
| 4 |
Config loading + hot-reload |
config/unified_config.h, config/config_watcher.h |
| 5 |
CLI argument parsing |
config/cli_config_parser.h |
| 6 |
Feature flags |
config/feature_flags.h |
| 7 |
Circular buffer & object pool |
utils/circular_buffer.h, utils/object_pool.h |
| 8 |
C++20 concepts showcase |
concepts/core.h, concepts/service.h |
| 9 |
Adapter pattern |
adapters/adapter.h, adapters/smart_adapter.h |
| 10 |
Health check composite |
interfaces/monitoring/health_check.h |
B. Document Splits (5 files)
| Document |
Size |
Split Into |
PRODUCTION_GUIDE.md |
75KB |
PRODUCTION_CONFIG.md, DEPLOYMENT_PATTERNS.md, CONTAINER_DEPLOYMENT.md, OBSERVABILITY.md |
INTEGRATION_GUIDE.md |
73KB |
INTEGRATION_DEPENDENCY_MAP.md, INTEGRATION_PATTERNS.md, INTEGRATION_LIFECYCLE.md |
CONFIG_GUIDE.md |
54KB |
CONFIG_UNIFIED.md, CONFIG_WATCHER.md, CONFIG_CLI_PARSER.md, CONFIG_LOADER.md |
FEATURE_FLAGS_GUIDE.md |
48KB |
FEATURE_FLAGS_USAGE.md, FEATURE_FLAGS_REFERENCE.md |
FEATURES.md |
42KB |
FEATURES_CORE.md, FEATURES_DI_CONFIG.md, FEATURES_INTEGRATION.md |
C. README Standardization
Move Quick Start section before Requirements to match canonical order.
Acceptance Criteria
What
Add 10 missing examples covering uncovered public API headers and split 5 oversized documentation files (42-75KB) for improved readability. Standardize README section ordering.
Current State
Why
As the Tier 0 foundation library, common_system's patterns (DI, EventBus, CircuitBreaker, Config) are used by all 7 downstream systems. Without examples for these core APIs, users cannot understand the patterns that the entire ecosystem depends on. Oversized docs (up to 75KB) are difficult to navigate and discourage reading.
How
A. New Examples (10 additions, 5→15)
di/service_container.h,di/unified_bootstrapper.hpatterns/event_bus.hresilience/circuit_breaker.hconfig/unified_config.h,config/config_watcher.hconfig/cli_config_parser.hconfig/feature_flags.hutils/circular_buffer.h,utils/object_pool.hconcepts/core.h,concepts/service.hadapters/adapter.h,adapters/smart_adapter.hinterfaces/monitoring/health_check.hB. Document Splits (5 files)
PRODUCTION_GUIDE.mdPRODUCTION_CONFIG.md,DEPLOYMENT_PATTERNS.md,CONTAINER_DEPLOYMENT.md,OBSERVABILITY.mdINTEGRATION_GUIDE.mdINTEGRATION_DEPENDENCY_MAP.md,INTEGRATION_PATTERNS.md,INTEGRATION_LIFECYCLE.mdCONFIG_GUIDE.mdCONFIG_UNIFIED.md,CONFIG_WATCHER.md,CONFIG_CLI_PARSER.md,CONFIG_LOADER.mdFEATURE_FLAGS_GUIDE.mdFEATURE_FLAGS_USAGE.md,FEATURE_FLAGS_REFERENCE.mdFEATURES.mdFEATURES_CORE.md,FEATURES_DI_CONFIG.md,FEATURES_INTEGRATION.mdC. README Standardization
Move Quick Start section before Requirements to match canonical order.
Acceptance Criteria
examples/CMakeLists.txt