Repository navigation
docs(tui): document Vim mode keys in README - #431
amandeavor wants to merge 2 commits into
Conversation
Add a Vim mode section to packages/tui/README.md listing the normal-mode bindings implemented in vim-mode.ts so users do not have to read the source. Closes Observal#426
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes.
 |
| Layer / File(s) | Summary |
|---|---|
Document supported Vim keys packages/tui/README.md |
Adds a Vim mode section describing mode switching and supported movement, editing, and slash-command keys. It notes that Enter, Alt+Enter, and Tab retain their usual editor bindings in normal mode. |
Priority:
Estimated code review effort: 1 (Trivial) | ~3 minutes
Change: Other · Severity of issue fixed: Low
Suggested reviewers: kaushik-kumar-ceg
Merge Risk: 
49772
-
The README accurately describes Vim mode and its editor bindings; no actionable merge risk remains.
Architecture risk: 
49772
-
The change affects 1 system.
Changed systems:
packages/tuiArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — packages/tui (library) was modified; 1 changed file maps to changed impact.
Before / after behavior
- observed — Modified behavior in packages/tui/README.md: Added documentation for Vim mode, its key bindings, and the editor bindings that remain unchanged in normal mode.
-
🚥 Pre-merge checks | ✅ 3 | ❌ 2
-
❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution Description check ⚠️ WarningThe description explains the change, links it to issue #426, and lists the documented key groups. However, it omits the required Purpose and Approach sections, does not report executed commands or res…Add the required Purpose and Approach sections, list each test or verification command with its result, complete the checklist, and include any applicable compatibility or license information. Linked Issues check ❓ Inconclusive The README adds the requested Vim mode section. Its keys match the reviewed controller: movement, insert-mode entry, f, deletion, undo/redo, kill-ring paste, slash commands, and normal-mode handling…Provide CI or command output that shows pnpm format:checkpasses for the pull request.✅ Passed checks (3 passed)
-
Check name Status Explanation Title check ✅ Passed The title clearly and concisely describes the README documentation change for Vim mode keys. Out of Scope Changes check ✅ Passed The reviewed change adds only the Vim mode documentation section in packages/tui/README.md. The section directly implements issue#426. No unrelated change is shown.Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Description check
-
Explanation
The description explains the change, links it to issue
#426, and lists the documented key groups. However, it omits the required Purpose and Approach sections, does not report executed commands or results, and does not include the repository checklist.
Full details: Linked Issues check
-
Explanation
The README adds the requested Vim mode section. Its keys match the reviewed controller: movement, insert-mode entry,
f, deletion, undo/redo, kill-ring paste, slash commands, and normal-mode handling for Escape, Enter, follow-up, and Tab. The repository evidence does not show apnpm format:checkresult, so the formatting acceptance criterion for issue#426cannot be confirmed.
-
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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 help to get the list of available commands.
Summary
Adds a Vim mode section to
packages/tui/README.mdwith a table of the normal-mode keys implemented inpackages/tui/src/vim-mode.ts.Closes #426
Details
hjkl,wb,0$,f<char>, arrows, Home/End), insert entry (iIaAoO), editing (x,dd,dw,u, Ctrl+R,p/P), and//:opening a slash commandpandPpaste from the kill ring)Test plan
packages/tui/src/vim-mode.tsSummary by CodeRabbit