docs: explain Connector use and repository ownership - #10
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.
Purpose
Turn the repository README into a usable guide for installing the Relay Connector, publishing two named buses, understanding component responsibilities, configuring transport behavior, and handling credentials and failures.
Product result
A Rust developer can identify the available Connector, see its complete declaration, and understand why provider transport code remains outside Core.
Architecture
Documentation only. Core owns capture and Session delivery; the Connector owns Relay client behavior; Relay owns server-side media forwarding.
Verification
Remaining limits
Connector version 0.1 supports STUN configuration but not TURN credentials. Published proof does not cover every NAT topology or production load.
Scaffold inventory: n/a
Decision: PASS