Skip to content

docs: add hotkey troubleshooting guide#689

Open
alexdcesm wants to merge 1 commit into
altic-dev:mainfrom
alexdcesm:docs/hotkey-troubleshooting
Open

docs: add hotkey troubleshooting guide#689
alexdcesm wants to merge 1 commit into
altic-dev:mainfrom
alexdcesm:docs/hotkey-troubleshooting

Conversation

@alexdcesm

Copy link
Copy Markdown

Description

Adds a concise hotkey troubleshooting guide for two common setup failures:

  • Mouse utilities such as Logitech G HUB or Logi Options+ intercepting a side button before FluidVoice receives it.
  • F13–F19 shortcuts requiring a device or remapping tool that can emit the actual function-key event.

The guide includes reset steps, a quick isolation test, and Karabiner-Elements/Stream Deck workarounds.

Type of Change

  • 🐞 Bug fix
  • ✨ New feature
  • 💥 Breaking change
  • 🧹 Chore
  • 📝 Documentation update

Related Issue or Discussion

Related to #622 and #411.

Testing

  • Ran git diff --check.
  • Reviewed the rendered Markdown structure and instructions.

Screenshots / Video

  • No UI/visual changes; screenshots/video are not applicable.

Notes

Documentation-only change based on reproduced setup issues with a remapped Logitech mouse button and an F18/F19 Stream Deck workflow.

@greptile-apps

greptile-apps Bot commented Jul 22, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds docs/HOTKEY_TROUBLESHOOTING.md, a new user-facing guide covering two reproducible hotkey setup failures: mouse utility software (e.g. Logitech G HUB, Logi Options+) intercepting side buttons before FluidVoice receives them, and F13–F19 keys requiring a physical device or remapping tool that actually emits the function-key event.

  • The mouse side-button section provides a clear 5-step resolution flow plus an isolation test (quitting the utility to confirm interception).
  • The F13–F19 section covers Karabiner-Elements and Stream Deck workarounds; the Stream Deck bullet references "the remapped key" without explicitly linking back to the Karabiner step, which could confuse users who jump straight to that option.
  • The guide is not linked from README.md or any other entry point, making it effectively undiscoverable for users hitting these issues.

Confidence Score: 4/5

Documentation-only change with no code modifications; safe to merge as-is, though discoverability would improve with a README link.

The guide content is technically accurate and the step-by-step instructions are sound. The two observations are minor: one bullet in the F13–F19 section uses 'the remapped key' without an explicit back-reference to the Karabiner step, and the file has no entry point from README.md, so users affected by these issues are unlikely to find it without browsing the docs directory directly.

README.md would benefit from a link to the new guide; docs/HOTKEY_TROUBLESHOOTING.md has one minor clarity gap in the Stream Deck bullet.

Fix All in Codex

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/HOTKEY_TROUBLESHOOTING.md:23
The third bullet references "the remapped key" without anchoring it to the Karabiner-Elements setup described in the preceding bullet. A user who skips straight to the Stream Deck option (or who uses a different remapping tool) will not know what "the remapped key" refers to. Making the phrase self-contained removes that ambiguity.

```suggestion
- To use `F18` with Stream Deck, first follow the Karabiner-Elements step above to create a key that emits `F18`, then use that key to enter `F18` in Stream Deck's Hotkey action field, and finally press that Stream Deck button while FluidVoice is recording its shortcut.
```

Reviews (1): Last reviewed commit: "docs: add hotkey troubleshooting guide" | Re-trigger Greptile


- Choose a low-conflict shortcut your keyboard can produce directly.
- Use Karabiner-Elements to map an unused key or key combination to `F18`, then trigger that mapping while FluidVoice is recording the shortcut.
- To use `F18` with Stream Deck, use the remapped key to enter `F18` in Stream Deck's Hotkey action field, then press that Stream Deck button while FluidVoice is recording its shortcut.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The third bullet references "the remapped key" without anchoring it to the Karabiner-Elements setup described in the preceding bullet. A user who skips straight to the Stream Deck option (or who uses a different remapping tool) will not know what "the remapped key" refers to. Making the phrase self-contained removes that ambiguity.

Suggested change
- To use `F18` with Stream Deck, use the remapped key to enter `F18` in Stream Deck's Hotkey action field, then press that Stream Deck button while FluidVoice is recording its shortcut.
- To use `F18` with Stream Deck, first follow the Karabiner-Elements step above to create a key that emits `F18`, then use that key to enter `F18` in Stream Deck's Hotkey action field, and finally press that Stream Deck button while FluidVoice is recording its shortcut.
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/HOTKEY_TROUBLESHOOTING.md
Line: 23

Comment:
The third bullet references "the remapped key" without anchoring it to the Karabiner-Elements setup described in the preceding bullet. A user who skips straight to the Stream Deck option (or who uses a different remapping tool) will not know what "the remapped key" refers to. Making the phrase self-contained removes that ambiguity.

```suggestion
- To use `F18` with Stream Deck, first follow the Karabiner-Elements step above to create a key that emits `F18`, then use that key to enter `F18` in Stream Deck's Hotkey action field, and finally press that Stream Deck button while FluidVoice is recording its shortcut.
```

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Fix in Codex

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.

2 participants