docs: add developer guides for backend design components - #446
Merged
Merged
Conversation
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
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.
Summary
Follow up #445 with developer guides for the public component interfaces required by the active designs.
Every developer guide now follows the same required structure:
The guides do not document private interfaces, functions, variables, implementation files, or internal helpers. Where current code has not converged on a stable public boundary, the document explicitly labels a target public API rather than presenting migration internals as API.
Public interfaces covered
Control plane
PlanningRequest -> SelectedLogicalPlan.CompiledPlanBundle.PlanPublisheractivation/rollback.Data plane
SummaryDecoder,SeriesIdentityResolver,SummaryValidator, andSummaryStateApplier.QueryService,SummaryReader, andExactQueryClient.SeriesRegistryandSummaryStore, including typed coverage results.SummaryCapabilityworkflow for adding a summary family.ASAPCollector correspondence
Runtime publication directly references ASAPCollector's authoritative
docs/developer_docs/opamp-config-push.mdrather than redefining CollectorPlan. It preserves:asap-collector-plan.yamlAgentConfigMap entry;config_hashversus cross-runtimeplan_id;io.asap.collector.plan.v1/application_reportsemantics; andNavigation
Validation
git diff --checkpub(crate), private interface/function/variable documentation, implementation file paths, or current-code maps;