Skip to content

docs(tui): document Vim mode keys in README - #431

Open
amandeavor wants to merge 1 commit into
Observal:mainfrom
amandeavor:docs/tui-vim-mode-keys
Open

amandeavor wants to merge 1 commit into
Observal:mainfrom
amandeavor:docs/tui-vim-mode-keys

Conversation

@amandeavor

@amandeavor amandeavor commented Sep 25, 2026 •

Copy link
Copy Markdown

Summary

Adds a Vim mode section to packages/tui/README.md with a table of the normal-mode keys implemented in packages/tui/src/vim-mode.ts.

Closes #426

Details

  • Documents movement (hjkl, wb, 0$, f<char>, arrows, Home/End), insert entry (iIaAoO), editing (x, dd, dw, u, Ctrl+R, p/P), and / / : opening a slash command
  • Notes that editing starts in insert mode and that Enter / Alt+Enter / Tab stay with ordinary editor bindings in normal mode
  • Keys are taken from the controller, not from the issue draft alone (e.g. both p and P paste from the kill ring)

Test plan

  • Skim the new section against packages/tui/src/vim-mode.ts
  • Confirm no competing open PR covers the same README change

Summary by CodeRabbit

  • Documentation
    • Added guidance for enabling Vim editing, switching modes, and using supported navigation and editing shortcuts. Clarified that Enter, Alt+Enter, and Tab keep their standard editor behavior in normal mode.

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
Copilot AI lite review requested due to automatic review settings September 25, 2026 07:43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: d4589fa7-59b9-4004-9b52-0f004a996670

📥 Commits

Reviewing files that changed from the base of the PR and between c9b6481 and 49772db.

📒 Files selected for processing (1)
  • packages/tui/README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The 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.

Changes

Vim mode documentation

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: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Low

Suggested reviewers: kaushik-kumar-ceg

Merge Risk: ⚪ Minimal · up to 49772

The README accurately describes Vim mode and its editor bindings; no actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 49772

The change affects 1 system.

Changed systems: packages/tui

Architecture 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 ⚠️ Warning 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 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:check passes 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 a pnpm format:check result, so the formatting acceptance criterion for issue #426 cannot be confirmed.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

Document the supported Vim keys in the TUI README

2 participants