docs/tui: rewrite Navigation section to match actual screens#309
Merged
Conversation
#58 The Navigation section described a three-level Home → Category → Detail architecture with category preview tiles, Tab/Shift-Tab tile navigation, and Home/Category screen headings. None of these exist. The Screen enum has two variants — UnifiedList and MergingPr — and the input module has no home_keys function and no Tab binding for tile navigation. Replace the section with an accurate two-screen description: UnifiedList (the main flat list with inline group expand/collapse via h/l) and the split detail pane (opened with Enter, closed with Esc). Every keybind in the new tables corresponds to a branch in unified_list_keys or the universal key handler in key_to_action. Also fix two stale references in the State machine section that named home_keys and list_keys instead of unified_list_keys and merge_confirm_key. Closes #58
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the TUI documentation to describe the actual navigation model and key bindings implemented in ui/tui/src/input.rs, replacing stale references to nonexistent screens and handlers.
Changes:
- Rewrites the Navigation section to document
UnifiedListplus the split detail pane behavior and keybinds. - Removes outdated Home/Category/Detail navigation descriptions and keybinds that don’t exist.
- Updates State machine references to match current key dispatch functions (
unified_list_keys,merge_confirm_key).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
| | Esc | back to category | | ||
| | ? | toggle help | | ||
| | q / Ctrl-C | quit | | ||
| One screen (`UnifiedList`) with an optional split detail pane. `Enter` opens the pane; `Esc` closes it. |
Comment on lines
+231
to
+233
| | o | open URL in browser | | ||
| | N | open blank task creation form | | ||
| | p | filter to PRs | |
| | m | merge PR (PR only) | | ||
| | d | open PR diff submenu (PR only) | | ||
| | a | approve for agent (issue only) | | ||
| | s | open task status submenu (task or badged signal) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✅ What
UnifiedListand the split detail paneTab/Shift-Tabtile navigation keybinds and theHome/Categoryheadingsunified_list_keysand the universal key handler ininput.rshome_keys/list_keys→unified_list_keys/merge_confirm_key)🤔 Why
The Navigation section described a tile-based Home screen that never shipped. Any agent or contributor following it would implement against a ghost architecture — the
Screenenum has noHomeorCategoryvariant,input.rshas nohome_keysfunction, andTabonly firesToggleSessionDetailwhen the split view is active.👩🔬 How to validate
ui/tui/README.mdand read the Navigation section — expect two headings:UnifiedListandSplit detail pane, with noHomeorCategoryheadingShift-Tab— expect zero matcheshome_keys— expect zero matchesui/tui/src/input.rsand scanunified_list_keys— expect every key listed in theUnifiedListtable to have a matching branch in that functionsplit_active) — expect every key in theSplit detail panetable to have a matching branch🔖 Related links
Closes #58
https://claude.ai/code/session_01FEgY11QaxQdZGmjUV23HjY
Generated by Claude Code