Skip to content

docs: rebuild the repository guide - #71

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

Rebuild the public README around the first runnable capture, source separation, multi-destination use, Connector authoring, application-owned PCM, permissions, platform evidence, and the documentation route.

Product result

A developer can understand the application-only default, add microphone or recording explicitly, and find the next guide without reading compiler or extension internals first.

Architecture

Documentation only. Session, Source, Operator, Connector, Endpoint, recording, and capture ownership are unchanged.

Verification

  • cargo fmt --all -- --check
  • cargo build --release --example quickstart --locked
  • bash scripts/check_protocol.sh
  • local links, Markdown fences, and git diff checks

Remaining limits

Windows and Linux device proof remains separate from VM correctness. WAN and TURN performance are not claimed.

Scaffold inventory: n/a
Decision: PASS

@Raphjacksun7
Raphjacksun7 merged commit c3661cd into main Sep 3, 2026
3 checks passed
@Raphjacksun7
Raphjacksun7 deleted the docs/rebuild-readme branch September 3, 2026 11:40
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