docs(tui): document Vim mode keys in README - #431
amandeavor wants to merge 1 commit 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
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe TUI README adds a Vim mode section. It describes how to enable Vim editing, switch modes, and use supported keys. It also notes that Enter, Alt+Enter, and Tab retain their usual editor bindings in normal mode. ChangesVim mode documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other · Severity of issue fixed: Low Suggested reviewers: Merge Risk: ⚪ Minimal · up to The README accurately describes Vim mode and its editor bindings; no actionable merge risk remains. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
Full details: Description checkExplanation The description explains the change, links it to issue Full details: Linked Issues checkExplanation The README adds the requested Vim mode section. Its keys match the reviewed controller: movement, insert-mode entry,
✨ 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 |
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