docs(discovery): add the ADR Discovery module specification - #56
Merged
Conversation
Discovery has a test plan in the repository but no document describing what the collector is or how it is built. This adds one. It states the four discovery targets and what is deliberately out of scope, the six sources the enumerator queries, the M1-M7 module split with its three cross-cutting concerns, the code layout that split implies and the import rules that hold it in place, the asset and coverage shapes, the redaction rules, the evaluation layers, and the build order. The status section is explicit that the implementation is not in this repository yet, so the file cannot be misread as documenting code that can be imported today.
lghupan
approved these changes
Aug 23, 2026
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.
What this adds
One file:
Discovery/adr_discovery/README.md, the specification for the ADR Discovery endpoint collector.Discovery already has a test plan in the repository (
Discovery/tests/README.md) but nothing describing what the collector is, what it has to find, or how it is built. This fills that gap.What it covers
world/touching the OS, no stage importing a sibling, all checkable by a single walk of the import graph.Notes for review
coverage.out_of_scoperather than silently omitted — so a clean machine stays distinguishable from an unasked question.