Skip to content

docs: explain Connector use and repository ownership - #10

Merged
Raphjacksun7 merged 1 commit into
mainfrom
docs/rebuild-readme
Sep 3, 2026
Merged

Raphjacksun7 merged 1 commit into
mainfrom
docs/rebuild-readme

Conversation

@Raphjacksun7

Copy link
Copy Markdown
Contributor

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

  • cargo fmt --all -- --check
  • cargo test --workspace --all-targets --all-features --locked
  • cargo clippy --workspace --all-targets --all-features --locked -- -D warnings
  • local links, Markdown fences, and git diff checks

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

@Raphjacksun7
Raphjacksun7 merged commit 9884d9b into main Sep 3, 2026
1 check passed
@Raphjacksun7
Raphjacksun7 deleted the docs/rebuild-readme branch September 3, 2026 11:38
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.

1 participant