Skip to content

docs: list ADR Discovery as a top-level module - #52

Merged
lghupan merged 1 commit into
mainfrom
docs/discovery-top-level-module
Aug 22, 2026
Merged

docs: list ADR Discovery as a top-level module#52
lghupan merged 1 commit into
mainfrom
docs/discovery-top-level-module

Conversation

@pengyuzhang

Copy link
Copy Markdown
Collaborator

Presents ADR Discovery as its own module in the README rather than as part of the Sensor.

What changed

README.md only, 4 insertions and 2 deletions:

  • Repository layout table gains a Discovery/ row, listed first to match the capability ordering in the section above it.
  • Capability overview no longer says Discovery "is not included in the current open-source release. Stay tuned.", and the description now covers IDE extensions and the open-world review queue.
  • Prose list of open-source components leads with ADR Discovery.
  • Component documentation gains a Discovery/README.md bullet.

Reviewer note: two links do not resolve yet

This is the documentation half of a larger change, so Discovery/ and Discovery/README.md will 404 until the endpoint collector actually moves. The collector currently lives on an unmerged branch under Sensor/adr_sensor/discovery/.

Merging this before the code move means main briefly advertises a directory it does not have. That is a deliberate tradeoff and worth a decision: hold this until the move lands, or take it now so the intended layout is documented up front.

The collector extraction is mechanical whenever it happens — nothing in discovery/ imports from adr_sensor outside its own package.

🤖 Generated with Claude Code

The capability overview described Discovery as absent from the open-source
release, and the repository layout table did not mention it at all. Both now
present it as its own module alongside the Sensor rather than as a part of it.

The Discovery/ and Discovery/README.md links do not resolve yet: the endpoint
collector itself lands in a separate change. This commit is the documentation
half, and the layout it describes is the intended one rather than the current
one.
@lghupan
lghupan merged commit 889fef5 into main Aug 22, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants