docs(examples): add 10 examples and split 5 oversized documents#624
Merged
Conversation
Add examples for: DI service container, event bus pub/sub, circuit breaker, config watcher, CLI parser, feature flags, circular buffer & object pool, C++20 concepts, adapter pattern, and health check interface. Closes partially #621
Move Quick Start before Requirements to follow the ecosystem's canonical README section ordering convention.
Split for improved readability and navigation: - FEATURES.md (42KB) -> 3 files (core, DI/config, integration) - FEATURE_FLAGS_GUIDE.md (48KB) -> 2 files (usage, reference) - CONFIG_GUIDE.md (54KB) -> 4 files (unified, watcher, CLI, loader) - PRODUCTION_GUIDE.md (75KB) -> 4 files (config, deploy, observability, security) - INTEGRATION_GUIDE.md (73KB) -> 3 files (deps, patterns, lifecycle) Original files replaced with index pages linking to sub-documents. All content preserved verbatim.
- Add sub-namespace using declarations (di, resilience, config, interfaces, adapters, utils) - Fix config_watcher API calls (remove non-existent methods) - Fix error accessor (error() returns string, not error_info) - Fix structured binding lambda capture for C++17 compat
- health_check_result: use field-by-field init (no aggregate init) - cli_parser: access error_info.message field directly - adapter: remove non-existent get_adapter_depth/is_adapter methods - concepts: reorder includes so std::string is in scope for concepts - config_watcher: add cstring include for strerror - concepts_showcase: simplify safe_unwrap to avoid Unwrappable concept instantiation issues
- feature_flags: conditionally include <source_location> header - config_watcher: move <cstring> before config_watcher.h to fix strerror undeclared in library header's inotify code
This was referenced Apr 8, 2026
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
* docs(examples): add 10 new examples covering uncovered APIs Add examples for: DI service container, event bus pub/sub, circuit breaker, config watcher, CLI parser, feature flags, circular buffer & object pool, C++20 concepts, adapter pattern, and health check interface. Closes partially #621 * docs(readme): reorder sections to canonical Quick Start first layout Move Quick Start before Requirements to follow the ecosystem's canonical README section ordering convention. * docs: split 5 oversized documents into focused sub-documents Split for improved readability and navigation: - FEATURES.md (42KB) -> 3 files (core, DI/config, integration) - FEATURE_FLAGS_GUIDE.md (48KB) -> 2 files (usage, reference) - CONFIG_GUIDE.md (54KB) -> 4 files (unified, watcher, CLI, loader) - PRODUCTION_GUIDE.md (75KB) -> 4 files (config, deploy, observability, security) - INTEGRATION_GUIDE.md (73KB) -> 3 files (deps, patterns, lifecycle) Original files replaced with index pages linking to sub-documents. All content preserved verbatim. * fix(examples): resolve namespace and API errors in new examples - Add sub-namespace using declarations (di, resilience, config, interfaces, adapters, utils) - Fix config_watcher API calls (remove non-existent methods) - Fix error accessor (error() returns string, not error_info) - Fix structured binding lambda capture for C++17 compat * fix(examples): resolve API mismatches and include ordering - health_check_result: use field-by-field init (no aggregate init) - cli_parser: access error_info.message field directly - adapter: remove non-existent get_adapter_depth/is_adapter methods - concepts: reorder includes so std::string is in scope for concepts - config_watcher: add cstring include for strerror - concepts_showcase: simplify safe_unwrap to avoid Unwrappable concept instantiation issues * fix(examples): add missing source_location and cstring includes - feature_flags: conditionally include <source_location> header - config_watcher: move <cstring> before config_watcher.h to fix strerror undeclared in library header's inotify code --------- Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #621
Summary
What
New Examples (5 → 15)
service_container_example.cppdi/service_container.hevent_bus_example.cpppatterns/event_bus.hcircuit_breaker_example.cppresilience/circuit_breaker.hconfig_watcher_example.cppconfig/config_watcher.hcli_parser_example.cppconfig/cli_config_parser.hfeature_flags_example.cppconfig/feature_flags.hutility_containers_example.cpputils/circular_buffer.h,utils/object_pool.hconcepts_showcase_example.cppconcepts/core.hadapter_pattern_example.cppadapters/adapter.hhealth_check_example.cppinterfaces/monitoring/health_check.hDocument Splits
FEATURES.mdFEATURE_FLAGS_GUIDE.mdCONFIG_GUIDE.mdPRODUCTION_GUIDE.mdINTEGRATION_GUIDE.mdOriginal files replaced with index pages linking to sub-documents. All content preserved verbatim.
README
Test Plan
cmake --build(CI verification)