docs: rebuild the Relay repository guide - #33
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
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.
Purpose
Rebuild the public README around starting Relay, choosing credential mode, publishing and receiving named buses, synchronization, capacity, security, ICE/TURN, observations, and published limits.
Product result
An operator can start a local Relay, understand what the health check proves, configure public deployment requirements, and find the correct operations or protocol reference.
Architecture
Documentation only. Relay continues to own WebRTC attachment and media forwarding. Core owns capture and recording; Control Plane owns RelaySession access state in control-plane mode.
Verification
Remaining limits
Synthetic local publication is not physical capture evidence. Repository tests do not establish every NAT topology, WAN latency, multi-region behavior, or production load.
Scaffold inventory: n/a
Decision: PASS