KoalaSync/docs

Technical Documentation

This directory contains deep-dives into the KoalaSync protocol, architecture, roadmap, and operational guidelines.

🏗️ Core Architecture & Design

• ARCHITECTURE.md: Overview of the communication flows, Dual Heartbeat architecture, and synchronization logic.
• HOW_IT_WORKS.md: Step-by-step walkthrough of every user flow, from room creation to synchronized playback. Ideal for store reviewers and manual testers.
• host-control-mode.md: Design, requirements, and edge cases of the Host Control feature.

📡 Protocol & Synchronization

• PROTOCOL.md: Low-level message format and payload descriptions for the KoalaSync sync protocol.
• SYNC_GUIDE.md: Guide on keeping protocol constants synchronized across the workspace.

📋 Compatibility, Roadmap & Contribution

• TESTED_SERVICES.md: Status of compatibility with major streaming services and contribution guidelines for testing new platforms.
• KNOWN_LIMITATIONS.md: Threat model and accepted design limitations (NOFIX entries) for security audits.
• ROADMAP.md: Planned features, backlog items, and rejected proposals.
• TRANSLATION.md: Guide for native speakers to contribute and audit dynamic extension/website translations.

🚀 DevOps & Releases

• devops.md: Guide on the automated tag-based release pipeline.
• CHANGELOG.md: Detailed history of releases and changes.

---

For high-level project information and developer setup instructions, refer to the root README.md.