Glossary
Glossary
| Term | Definition |
|---|---|
| Docs as Code | Treating documentation with the same version control, review, testing, and release discipline as software |
| Internal docs | Technical documentation for builders and operators |
| User-facing docs | Documentation for people using the product |
| ADR | Architecture Decision Record |
| SSoT | Single source of truth |
| Room | A specialized, domain-tailored user experience layer (e.g. Music Room, Podcast Room, Audiobook Room) running on top of the Rymflux platform framework |
| Plugin | An external, language-agnostic executable providing content capabilities (search, stream resolution, metadata) over JSON-RPC 2.0 via stdin/stdout |
| Content ID | A canonical UUIDv4 string that uniquely identifies a piece of content (track, album, playlist) in the unified library, decoupled from any specific source plugin |
| Resolution Entry | A record mapping a unified Content ID to a specific source plugin ID and external track/content key for stream resolution |
| Phonic Engine | The Rust audio playback library (phonic) wrapping cpal (audio output), symphonia (audio decoding), and rubato (sample rate conversion) |
| Svelte 5 Runes | Svelte 5’s fine-grained reactivity primitives ($state, $derived, $effect) used in .svelte.ts modules to manage application state |
| Room Context | The standardized handle and lifecycle API (RoomContext) provided by the shell framework to rooms for controlling playback, queue, navigation, and state |