ECall iOS Documentation
This folder is organized by audience. Start with the path that matches your role, then drill down only when needed.
Reading Paths
Folder Layout
| Folder | Purpose | Style |
business/ | Product intent, user behavior, value proposition | Non-technical, business-readable |
dev/ | App behavior, security model, architecture, flows | Developer-readable, code-aligned |
partner/ | Setup, branding, Apple/Firebase/Store readiness | Operational step-by-step |
partner/git-outsource/ | Open-source governance docs | Contributor-facing |
Developer Docs
| Area | Main docs |
| Authentication | Overview, Authentication Flow, Device Registration |
| Calls | Overview, 1-1, Group, Join/Rejoin, E2EE, Architecture |
| Contacts | Overview, Friend Request Flow, QR Generation, QR Resolve |
| Networking | API Client, Configuration, Token Refresh, Token Refresh Diagram |
| Security | Current Security Architecture, SSL Pinning, API Request Signing, KT on iOS |
Documentation Rules
- Overview docs explain business behavior and flow first.
- Technical architecture docs contain implementation names and file-level traceability.
- Diagrams should show decisions and data flow, not duplicate every code detail.
- Avoid absolute claims such as "perfect", "100%", or "impossible" unless backed by code and threat model.
- Keep docs aligned with the current LiveKit-based call stack.
- Do not reintroduce removed call stacks, transport layers, or deleted endpoint references.