Skip to content

docs(usage): refresh journal log section for v3.0.x behavior - #113

Merged
ericmann merged 3 commits into
mainfrom
docs/usage-log-freshness
Jul 2, 2026
Merged

ericmann merged 3 commits into
mainfrom
docs/usage-log-freshness

Conversation

@ericmann

@ericmann ericmann commented Jul 2, 2026

Copy link
Copy Markdown
Owner

USAGE.md's voice-notes section predated three shipped behaviors:

  1. Start-press preflight (journal log: preflight the transcriber toolchain at record-start, not after recording #82) — the fail-fast list mentioned only ffmpeg/platform, but the starting press also verifies the whisper.cpp binary and model, so a recording is never spent on a pipeline that can't process it.
  2. Failure notifications (fix(log): notify on hotkey-flow failure instead of failing silently #81) — the notifications paragraph described only "● recording" and "✓ logged"; failures ("✕ journal log failed" + retryable WAV path) and empty recordings ("empty recording — nothing to log") notify too.
  3. log.transcriber.model_id (fix(models): pull the whisper.cpp ggml model journal log actually needs #112, v3.0.1) — the config-key list omitted the new ggml provisioning key.

Docs-only; caught during a post-v3.0.1 read-through of the section.

ericmann added 2 commits July 2, 2026 11:11
The voice-notes section predated three shipped behaviors: the start
press now preflights the whisper.cpp binary/model (#82), failures and
empty recordings pop notifications (#81), and log.transcriber gained
model_id for ggml provisioning (#112). Bring the fail-fast list, the
notification paragraph, and the config-key list up to date.
…he boolean status

The optional Hammerspoon menubar snippet matched ^recording against
hs.execute's second return, a boolean — status:match(...) is a Lua
error, so the dot could never turn ● during a recording. Match the
output string (journal log --status prints "recording (...) — <wav>").
Found by a user copying the snippet verbatim.
@ericmann

ericmann commented Jul 2, 2026

Copy link
Copy Markdown
Owner Author

Added a second commit: the optional menubar-dot snippet had a real bug — it matched ^recording against hs.execute's second return value (a boolean; status:match(...) is a Lua error), so the dot could never turn ● during a recording. Now matches the output string. Found in live testing when the snippet was copied verbatim.

…on't source shell rc

Found in live testing: with the repo resolved via JOURNAL_DIR exported
in ~/.zshrc, the documented hotkey binding silently does nothing —
Hammerspoon children never see the variable, journal exits 'not inside
a journal repo', and the task's output is discarded. Thread the env
through both the hotkey task and the menubar-dot poll.
@ericmann
ericmann merged commit 7cf3dff into main Jul 2, 2026
2 checks passed
@ericmann
ericmann deleted the docs/usage-log-freshness branch July 2, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant