docs: add domain glossary (CONTEXT.md) - #41
Conversation
Referenced by docs/adr/0002 but never pushed in the original commit. Resolves the dangling reference reported in #40.
📝 WalkthroughWalkthroughAdds a new ChangesVoiceFlow Domain Glossary
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTEXT.md (1)
18-20: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick winConsider adding event naming convention to system touchpoints.
The enumeration of "system touchpoints" (DB, RPC, services, filesystem, logs) omits a critical contract: the event naming pattern. According to
src-pyloid/services/recording/controller.py:738-762, Recording lifecycle events follow the patternrecording-<kind>-complete(e.g.,recording-transcribe-complete) and are emitted for all terminal outcomes. This is explicitly documented as a contract that "the frontend depends on."Including this pattern in the glossary would align the documentation with the actual domain boundaries and help new contributors understand how Recordings integrate across the system.
💡 Suggested addition to line 18-20
A Recording is the entity in the DB (`recordings` table), in RPC methods (`recordings_*`), -in services (`RecordingService`, `RecordingsRepository`), in the audio folder -(`~/.VoiceFlow/recordings/`), and in logs (`domain=recording`). +in services (`RecordingService`, `RecordingsRepository`), in the audio folder +(`~/.VoiceFlow/recordings/`), in logs (`domain=recording`), and in events +(`recording-<kind>-complete`, e.g., `recording-transcribe-complete`).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTEXT.md` around lines 18 - 20, The CONTEXT.md documentation lists system touchpoints for Recording entities (DB, RPC, services, filesystem, logs) but omits the event naming convention which is a critical contract. According to the actual implementation, Recording lifecycle events follow the pattern `recording-<kind>-complete` for all terminal outcomes and the frontend depends on this contract. Add the event naming convention as a documented system touchpoint in the Recording glossary entry to align the documentation with the actual domain boundaries and clearly communicate to new contributors how Recording events are named and emitted across the system.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CONTEXT.md`:
- Around line 18-20: The CONTEXT.md documentation lists system touchpoints for
Recording entities (DB, RPC, services, filesystem, logs) but omits the event
naming convention which is a critical contract. According to the actual
implementation, Recording lifecycle events follow the pattern
`recording-<kind>-complete` for all terminal outcomes and the frontend depends
on this contract. Add the event naming convention as a documented system
touchpoint in the Recording glossary entry to align the documentation with the
actual domain boundaries and clearly communicate to new contributors how
Recording events are named and emitted across the system.
What
Adds
CONTEXT.md, the VoiceFlow domain glossary. It defines the canonical "Recording" terminology (the meeting-notes feature) used across the DB, RPC methods, services, and logs, and documents the deliberate "Recording" in code / "Meeting" in the UI split.Why
docs/adr/0002-recording-vs-meeting-naming.mdalready references this file ("...See CONTEXT.md"), but it was never committed, leaving a dangling reference. Reported by an external contributor in #40.Notes
Closes #40.