docs: add keybinding improvement proposal for TUI#49
docs: add keybinding improvement proposal for TUI#49AndreaDiazCorreia wants to merge 2 commits intomainfrom
Conversation
WalkthroughA new documentation file proposes a three-phase plan to standardize Mostrix TUI keybindings, specifying concrete shortcuts ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
![coderabbitai[bot]](https://avatars.gh.lumenfield.work/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/KEYBINDING_PROPOSAL.md (1)
140-144: Avoid brittle hard-coded line numbers in cross-file references.Line 140 and Line 143 pin exact line numbers in other files/docs; these will drift quickly and make the proposal stale. Prefer section anchors, symbol names, or quoted snippets only.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/KEYBINDING_PROPOSAL.md` around lines 140 - 144, The proposal currently references exact line numbers for the "'Q' to quit" entry in the TUI_INTERFACE doc but the keybinding was removed (see the comment "'q' key removed - use Exit tab instead." in the key_handler mod), and those hard-coded line numbers will drift; update the KEYBINDING_PROPOSAL.md references to remove line numbers and instead point to stable anchors or section headers (or include a short quoted snippet) for the TUI_INTERFACE entry, and also update the text to reflect that the 'Q' binding is gone by citing the key_handler mod comment/symbol so the doc stays accurate and resilient to edits.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/KEYBINDING_PROPOSAL.md`:
- Around line 72-74: Replace the absolutist phrase "not a recognized convention
in any major TUI" in KEYBINDING_PROPOSAL.md with a softer term such as "less
common" or "uncommon" (e.g., change to "Ctrl+H is less common in major TUIs") so
the wording is accurate over time; locate the sentence containing "Ctrl+H" and
update that clause only while preserving the surrounding explanation about
discoverability and the recommendation to prefer "?".
---
Nitpick comments:
In `@docs/KEYBINDING_PROPOSAL.md`:
- Around line 140-144: The proposal currently references exact line numbers for
the "'Q' to quit" entry in the TUI_INTERFACE doc but the keybinding was removed
(see the comment "'q' key removed - use Exit tab instead." in the key_handler
mod), and those hard-coded line numbers will drift; update the
KEYBINDING_PROPOSAL.md references to remove line numbers and instead point to
stable anchors or section headers (or include a short quoted snippet) for the
TUI_INTERFACE entry, and also update the text to reflect that the 'Q' binding is
gone by citing the key_handler mod comment/symbol so the doc stays accurate and
resilient to edits.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 91d1d520-a184-4256-8313-9e7d35d84934
📒 Files selected for processing (1)
docs/KEYBINDING_PROPOSAL.md
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/KEYBINDING_PROPOSAL.md (1)
264-265: Clarify hint bar merge strategy.Lines 264-265 state the hint bar "should yield to it or merge them to avoid duplication." Consider specifying which approach is preferred or under what conditions each applies. For example: "The global hint bar should not render when on the Disputes In Progress tab to avoid duplication" or "The global hint bar should merge with Disputes-specific hints."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/KEYBINDING_PROPOSAL.md` around lines 264 - 265, Clarify the merge strategy by specifying a single rule: prefer hiding the global hint bar when the Disputes In Progress tab is active to avoid duplication, and if a unified display is later desired, define a merge behavior where Disputes-specific footer hints take precedence and are appended to any condensed global hint; update the text around "global hint bar" and "Disputes In Progress tab" to state this explicit behavior and the fallback merge order.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/KEYBINDING_PROPOSAL.md`:
- Around line 135-144: The docs still instruct users to press `Q` to quit but
the implementation removed that keybinding; update the documented sentence that
currently reads "Pressing `Q` or selecting the Exit tab shows a confirmation
popup..." to remove the `Q` reference and state that selecting the Exit tab
shows the confirmation popup (or explicitly note that the `Q` key was removed
and users must use the Exit tab), ensuring the documentation matches the code
comment "'q' key removed - use Exit tab instead." and any other occurrences of
the `Q` keybinding in the same document.
---
Nitpick comments:
In `@docs/KEYBINDING_PROPOSAL.md`:
- Around line 264-265: Clarify the merge strategy by specifying a single rule:
prefer hiding the global hint bar when the Disputes In Progress tab is active to
avoid duplication, and if a unified display is later desired, define a merge
behavior where Disputes-specific footer hints take precedence and are appended
to any condensed global hint; update the text around "global hint bar" and
"Disputes In Progress tab" to state this explicit behavior and the fallback
merge order.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 72983d7c-69c6-4f2f-98c1-6b981b56c4f8
📒 Files selected for processing (1)
docs/KEYBINDING_PROPOSAL.md
|
Great add, I lilke most of it but I disagree with the "q" to quit, yes all simple TUIs have q to quit, but this is not a simple TUI app, mostrix have two modes and each mode have many options, q to quit can work on TUI where they don't have a input text but we have several input text. I propose ctrl+D to quit which is the "standard" for more complex TUIs, and keep the exit tab and enter to exit there. About moving with tabs that could be the done only if we think how to behave in the case admin want to move between tabs to talk to buyer/seller |
2 participants
Adds a proposal document outlining keybinding improvements for the Mostrix TUI, inspired by conventions from widely-used terminal applications like lazydocker, bluetui, and htop. The proposal covers three phases: quick wins (q to quit, ? for help, Tab to cycle tabs, Shift+M for mode switch), a context-aware keybinding hint bar in the footer, and optional advanced navigation features. It includes a comparison with existing TUI conventions, documents all current keybindings, and identifies a doc-code discrepancy where Q to quit is documented but was removed from the code.
Summary by CodeRabbit