docs: VoIP subsystem documentation

[diegolmello]

Proposed changes

Adds documentation for the VoIP subsystem under app/lib/services/voip/docs/. Covers architecture, cross-runtime flows, and platform quirks — content that previously lived only in code comments and PR descriptions.

Files added:

• ARCHITECTURE.md — runtimes, layers, state model, signaling protocol, native bridge contract, invariants.
• FLOWS.md — six Mermaid sequence diagrams (init/teardown, outgoing, incoming warm/cold, cross-workspace, end call) plus an audio-control-sync subsection.
• PLATFORMS.md — iOS and Android quirks (PushKit/CallKit, FCM/Telecom, audio routing, manifest and Info.plist).
• README.md — index.

Also:

• Adds three glossary terms to UBIQUITOUS_LANGUAGE.md: Native Accept, Per-call DDP, Media Signal.
• Anchors the gitignore docs/ rule to the repo root (/docs/) so subsystem-level docs/ directories commit normally.

Issue(s)

https://rocketchat.atlassian.net/browse/VMUX-111

How to test or reproduce

Open each .md in a Markdown preview that supports Mermaid (GitHub PR diff renders Mermaid natively). Verify all six sequence diagrams render and intra-/inter-doc anchor links resolve.

Screenshots

n/a — text only.

Types of changes

• Documentation update (if none of the other choices apply)

Checklist

• I have read the CONTRIBUTING doc
• I have signed the CLA
• Lint and unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works (if applicable)
• I have added necessary documentation (if applicable)
• Any dependent changes have been merged and published in downstream modules

Further comments

Docs only — no source changes, so unit tests are unaffected. Native build paths are not touched.

Summary by CodeRabbit

• Documentation
  • Added comprehensive VoIP subsystem documentation including architecture design, end-to-end call flows with visual diagrams, platform-specific implementation details for iOS and Android, and expanded terminology glossary.
  • Improved overall documentation structure and reference materials.

[coderabbitai]

Caution

Review failed

Failed to post review comments

Walkthrough

Adds comprehensive VoIP documentation (architecture, flows with diagrams, platform notes, and README), appends three glossary terms to UBIQUITOUS_LANGUAGE.md, and anchors the docs ignore rule in .gitignore by changing docs/ to /docs/.

Changes

VoIP documentation & glossary

Layer / File(s)	Summary
Glossary Definitions UBIQUITOUS_LANGUAGE.md	Inserted three Video & Voice terms: Native Accept, Per-call DDP, and Media Signal with definitions and aliases.
Architecture / Data shape app/lib/services/voip/docs/ARCHITECTURE.md	Added VoIP Architecture doc describing runtimes (TS/Swift/Kotlin), three-layer model (Native UX, Signaling, Media), State Model (singleton MediaSessionInstance, Call store fields), and invariants.
Architecture / Core behavior app/lib/services/voip/docs/ARCHITECTURE.md	Documented native-accept race handling, in-call and self-call guards, live ICE config, peer autocomplete store, signaling roles, DDP transport and REST replay, and Native Bridge Contract (per-call DDP, cross-JS/native events, cold-start, cross-workspace race).
Flows / Control flow narratives app/lib/services/voip/docs/FLOWS.md	Added six end-to-end flows with narrative and Mermaid sequence diagrams: Init/teardown, Outgoing, Incoming (warm), Incoming (cold start), Cross-workspace incoming, End call; plus Audio control sync (Mute/Hold/Speaker) and verification markers.
Platforms / Integration notes app/lib/services/voip/docs/PLATFORMS.md	New platform-specific guidance for iOS/Android: PushKit/APNS behavior, CallKit/native accept flow, per-call DDP registry, Info.plist keys/entitlements, Android Telecom/foreground service, audio routing, FCM data-only dispatch, and permissions.
Docs index app/lib/services/voip/docs/README.md	Added VoIP docs README with index and glossary reference.

.gitignore configuration

Layer / File(s)	Summary
Ignore Pattern Anchoring .gitignore	Changed docs/ to /docs/ to anchor the ignore rule to the repository root.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: VoIP subsystem documentation' directly and accurately describes the main change: comprehensive documentation additions for the VoIP subsystem.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• VMUX-111: Request failed with status code 401

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[OtavioStasiak]

LGTM