Skip to content

docs: fix terminal docs factual issues + keybinding/link style pass (non-SSH half of GROW-6086) - #595

Draft
warp-agent-staging[bot] wants to merge 3 commits into
mainfrom
factory/grow-6086-terminal-docs-factual-style
Draft

docs: fix terminal docs factual issues + keybinding/link style pass (non-SSH half of GROW-6086)#595
warp-agent-staging[bot] wants to merge 3 commits into
mainfrom
factory/grow-6086-terminal-docs-factual-style

Conversation

@warp-agent-staging

@warp-agent-staging warp-agent-staging Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Non-SSH half of the GROW-6086 terminal docs follow-up: the remaining factual issues (stale subshell defaults, dead/mislabeled Command Palette references, a pre-Ventura macOS path) plus a keybinding/link-text style pass across src/content/docs/terminal/.

The SSH/Warpify reframe is deliberately out of scope for this PR. terminal/warpify/ssh.mdx, terminal/warpify/ssh-legacy.mdx, terminal/warpify/index.mdx, and the Warpify SSH section of terminal/settings/all-settings.mdx are untouched — that's a separate information-architecture decision pending with the requester.

Split into three commits so the factual fixes, the style sweep, and a follow-up review-driven correction can each be reviewed independently.

Related issues

GROW-6086 — Update Terminal docs

Changes

Commit 1 — factual fixes

  • warpify/subshells.mdx — replaced the stale "by default" subshell-compatible command list with the actual SUBSHELL_COMMAND_REGEXES defaults from app/src/terminal/warpify/settings.rs (bash/zsh/fish, docker/podman run/exec, poetry shell, pipenv shell, aws-vault exec, flox activate, wsl on Windows). Removed gcloud compute ssh / eb ssh, which have no built-in regex. Also tightened the denylist reference to the exact live UI list name Denylisted commands (settings_view/warpify_page.rs).
  • windows/global-hotkey.mdx — updated the pre-Ventura System Preferences path to System Settings, using the macOS Apple-icon menu-path convention.
  • more-features/full-screen-apps.mdx — fixed the "Mouse Reporting" Command Palette entry casing to match the real dynamic action description ("Enable/Disable mouse reporting", lowercase) produced by ToggleSettingActionPair in settings_view/features_page.rs / settings_view/mod.rs.
  • editor/vim.mdx — fixed the "Vim Keybindings" Command Palette reference to the real dynamic entry "Enable/Disable editing commands with Vim keybindings", and fixed the Settings toggle label to the current text "Edit code and commands with Vim keybindings" (VimModeWidget). "Exit Vim insert mode" was already correct.

Commit 2 — style pass

  • Normalized legacy key-chord notation (CMD-P, SHIFT-CMD-C, CTRL-TAB, plus +/space-separated and Windows META variants) to the AGENTS.md convention across ~30 files: ⌘+P, ⌘+Shift+C, Ctrl+Tab, arrow symbols for Up/Down/Left/Right, and spelled-out named keys (Enter, Esc, Home, End, Page Up, Page Down, etc). Left literal shell/config strings and mouse-click terms (RIGHT-CLICK, TRIPLE-CLICK) untouched.
  • editor/index.mdx — while normalizing the keybinding table, fixed two cells that had been corrupted into single elements during the docs migration: a Ctrl+K Cmd+Delete cell split into two alternatives, and a "start / end of line" row that had an erroneous extra Cmd+Down binding (verified against editor/view/mod.rsCmd+Down maps to a different action, moving to the bottom of the buffer).
  • entry/yaml-workflows.mdx — replaced commands.dev used as bare link text with descriptive anchor text.

Commit 3 — review-driven fixes

A second review pass found the two-cell fix in editor/index.mdx above hadn't gone far enough, plus one more wording issue:

  • windows/global-hotkey.mdx — current macOS System Settings shows a per-app toggle for Accessibility access, not a checkbox. Reworded the step accordingly.
  • editor/index.mdx — rebuilt all three keybinding tables (macOS, Windows, Linux) row by row against editor/view/mod.rs, finding eight more defects beyond the two already fixed: a delete-vs-cut conflation for "everything to the right" (also present on Windows/Linux, where no true delete-only binding exists), delete-word bindings that duplicated the cut-word bindings on all three platforms, a non-Mac "clear selected lines" row with no matching binding, a mac "select everything left/right" row mislabeled (it's actually "select to line start/end", SelectToLineStart/SelectToLineEnd) with the equivalent Windows/Linux cells left empty, a non-Mac "move cursor to start/end of line" row using a mac-only binding (Linux Ctrl+E is actually a distinct "Emacs-style binding" hint, not cursor movement), and swapped word/subword navigation chords on Windows/Linux. Of ~20 rows per table, 10 were changed; the rest were confirmed correct against source and left unchanged.

Migration status (what survived vs. what this PR fixes)

Per the orchestrator's request, here's what changed between the original gitbook-era triage and the migrated Astro/Starlight repo:

  • Already fixed by the migration: all 37 empty/generic image alts from the original triage count (0 remain in terminal/); the "here"/"this page" bare link text items (0 remain); Universal Input references (confined to the properly sidebar: hidden legacy page with a caution banner); denylist heading/wording in subshells.mdx (only the exact UI element name needed tightening); vim.mdx's "Exit Vim insert mode" casing.
  • Still stale, fixed here: the subshell defaults list, the System Preferences path, the Mouse Reporting and Vim Keybindings Command Palette casing.
  • New discovery, not in the original triage: two corrupted table cells in editor/index.mdx (see above) — a migration artifact, not something the original gitbook triage could have found since that content didn't exist in that form pre-migration.

Unverified claims

None — all UI labels, Command Palette entries, and Settings paths touched in this PR were verified directly against warp-internal/warp source (app/src/terminal/warpify/settings.rs, app/src/settings_view/warpify_page.rs, app/src/settings_view/features_page.rs, app/src/settings_view/mod.rs, app/src/editor/view/mod.rs, app/src/search/command_palette/data_sources.rs).

One tooling note for reviewers: vim.mdx's "Enable/Disable editing commands with Vim keybindings" Command Palette reference still shows as unmatched by validate_ui_refs.py. This is a validator limitation, not a doc error — the entry is a dynamically-generated FixedBinding description (via ToggleSettingActionPair, app/src/settings_view/mod.rs), and the extraction script only parses static EditableBinding::new(...) calls. I traced the exact string through settings_view/features_page.rsToggleSettingActionPair::new("editing commands with Vim keybindings", ...)format!("Enable {description_suffix}") to confirm it's correct.

Validation

  • npm run build — passes.
  • npm run typecheck — 0 errors, 0 warnings (pre-existing hints only).
  • python3 .agents/skills/validate_ui_refs/validate_ui_refs.py --check-paths --check-commands --check-format --warp ../warp — 0 settings-path issues, 0 format issues repo-wide; 1 command-palette "issue" which is the known validator limitation described above (verified correct against source).
  • python3 .agents/skills/check_for_broken_links/check_links.py --internal-only — 0 broken links (3858 checked). Re-ran build, typecheck, and both validators after Commit 3; all still pass with the same single known validator-limitation flag.
  • python3 .agents/skills/style_lint/style_lint.py --all — 0 remaining issues in terminal/ for the categories this PR addresses (deprecated-term, link-anchor, oz-term, product-casing, external-casing). Remaining terminal-scoped flags (header-case: 14, ui-backtick: 2, screenshot-width: 49, unrecognized-term: 109) were reviewed by hand and are either false positives or out of scope — see Follow-ups.
  • The checked-in .agents/skills/validate_ui_refs/valid_paths.json snapshot was refreshed locally against ../warp for research/verification purposes only, to confirm real Command Palette strings; that refresh is not included in this diff.

Follow-ups

  • SSH/Warpify reframe — tracked as the other half of GROW-6086, pending the five IA questions posed to the requester (tmux vs. extension model, legacy content scope, ssh-feature-support.md scope, etc.).
  • header-case (14 flags) — reviewed by hand; all are false positives. Sticky Command Header, Tab Config(s), Launch Configuration(s), Session Navigation, and Session Restoration are used consistently as each page's own established feature name throughout (title, headers, body) — changing only the flagged H2s would create inconsistency with the rest of the page. Markdown and Finder are genuine proper nouns. No changes made.
  • ui-backtick (2 flags)`.command` and `settings.toml` are file names, not UI elements; backticks are correct per the style guide. No changes made.
  • screenshot-width (49 flags) — standardizing <figure> maxWidth values is a real but separate cleanup; out of scope here since it's unrelated to the factual/keybinding/link fixes this issue asked for, and the brief said not to touch screenshots.
  • unrecognized-term (109 flags) — glossary-addition suggestions only, not errors.

warp-agent-staging Bot and others added 2 commits August 21, 2026 00:40
…ng, vim)

- warpify/subshells.mdx: replace the stale "by default" subshell-compatible
  command list with the actual SUBSHELL_COMMAND_REGEXES defaults from
  app/src/terminal/warpify/settings.rs (bash/zsh/fish, docker|podman
  run/exec, poetry shell, pipenv shell, aws-vault exec, flox activate, wsl
  on Windows). Removes gcloud compute ssh / eb ssh, which have no built-in
  regex. Also tightens the denylist reference to the exact live UI list
  name "Denylisted commands" (settings_view/warpify_page.rs).
- windows/global-hotkey.mdx: update the pre-Ventura System Preferences path
  to System Settings, using the macOS Apple-icon menu-path convention.
- more-features/full-screen-apps.mdx: fix the "Mouse Reporting" Command
  Palette entry casing to match the real dynamic action description
  ("Enable/Disable mouse reporting", lowercase "mouse reporting") produced
  by ToggleSettingActionPair in settings_view/features_page.rs /
  settings_view/mod.rs.
- editor/vim.mdx: fix the "Vim Keybindings" Command Palette reference to
  reflect the real dynamic entry "Enable/Disable editing commands with Vim
  keybindings", and fix the Settings toggle label to the current text
  "Edit code and commands with Vim keybindings" (VimModeWidget in
  settings_view/features_page.rs). The "Exit Vim insert mode" Command
  Palette reference was already correct after the docs migration.

Co-Authored-By: Warp <agent@warp.dev>
Sweeps docs/warp/terminal (src/content/docs/terminal/), excluding the
SSH/Warpify pages pending a separate reframe decision.

- Normalize legacy key-chord notation (CMD-P, SHIFT-CMD-C, CTRL-TAB, and
  variants using +, spaces, or Windows META bindings) to the AGENTS.md
  convention: `⌘+P`, `⌘+Shift+C`, `Ctrl+Tab`, arrow symbols for
  Up/Down/Left/Right, and spelled-out named keys (Enter, Esc, Tab, Space,
  Backspace, Delete, Home, End, Page Up, Page Down). Left literal
  shell/config strings and mouse-click terms (RIGHT-CLICK, TRIPLE-CLICK)
  untouched.
- editor/index.mdx: while normalizing the keybinding reference table,
  fixed two cells that had been corrupted into single elements: a
  "Ctrl+K Cmd+Delete" cell split into two alternatives, and a "start / end
  of line" row that had an erroneous extra "Cmd+Down" binding (verified
  against editor/view/mod.rs — Cmd+Down maps to a different action,
  moving to the bottom of the buffer).
- entry/yaml-workflows.mdx: replace "commands.dev" used as bare link text
  with descriptive anchor text per the link-quality guide.

Ran `.agents/skills/style_lint/style_lint.py` and `validate_ui_refs.py`
scoped to docs/warp/terminal and confirmed no other actionable issues
(remaining flags are either false positives — established page-level
feature names like "Tab Configs"/"Session Navigation", or genuine proper
nouns like "Markdown"/"Finder" — or out of scope, like screenshot-width
standardization and glossary suggestions).

Co-Authored-By: Warp <agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Aug 21, 2026
@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 21, 2026 1:08am

Request Review

…g tables

Second-pass review of PR #595 found the macOS Accessibility permission
step used stale "checkbox" wording, and traced ten separate defects in
the editor/index.mdx keybinding tables that predate this PR (verified
against app/src/editor/view/mod.rs):

- windows/global-hotkey.mdx: current macOS System Settings shows a
  per-app toggle for Accessibility access, not a checkbox. Reworded to
  "toggle the switch next to Warp on", per the style guide's preference
  for "toggle" over "checkbox" language.

- editor/index.mdx: rebuilt all three keybinding tables (macOS, Windows,
  Linux) row by row against editor/view/mod.rs. Fixes:
  - Split the mac "Ctrl+K / Cmd+Delete" row (CutAllRight vs
    DeleteAllRight are different actions with different clipboard
    behavior) into two rows with accurate descriptions; the Windows/Linux
    "Ctrl+K" row had the same delete-vs-cut conflation and no true
    delete-all-right binding exists there, so it's now a single
    cut-only row.
  - Fixed delete-word bindings on all three platforms: they duplicated
    the cut-word bindings (Option+D/Alt+D). Real delete bindings are
    Option+Delete (mac) / Ctrl+Delete (Windows, Linux) to the right, and
    Ctrl+Backspace (Windows, Linux; was wrongly Alt+Backspace) to the
    left.
  - Removed the non-Mac "Ctrl+Shift+K clear selected lines" row —
    ClearLines is mac-only; Ctrl+U already documents the cross-platform
    equivalent.
  - Reworded the mac "Select everything left/right" row (⌘+Shift+←/→) to
    "Select to the start/end of the line", matching SelectToLineStart /
    SelectToLineEnd, and filled the equivalent empty Windows/Linux cells
    with Shift+Home / Shift+End and the same wording.
  - Filled the empty Windows/Linux "select character left/right" cells
    with Shift+←/→ (a cross-platform binding already shown correctly on
    mac).
  - Removed the non-Mac "Ctrl+A/Ctrl+E move cursor to start/end of line"
    row — that binding is mac-only; Linux's Ctrl+E is a distinct
    "Emacs-style binding" hint, not cursor movement, and Windows has
    neither.
  - Fixed non-Mac word-navigation: "Alt+←/→" is actually the (mac-only)
    subword binding; the real word-move binding on Windows/Linux is
    Ctrl+←/→. Removed the non-Mac subword row since no default binding
    exists there.

Of the ~20 rows in each table, 10 were changed and the rest were
confirmed correct against source (unchanged): Escape, Ctrl+L, Ctrl+H,
Ctrl+C (clear buffer), Ctrl+U, Copy/Cut/Paste, cut-word (Ctrl+W /
Option+D or Alt+D), mac subword nav, mac move-to-line-start/end, select
character (mac), select-word (mac Option+Shift, non-Mac Meta+Shift+B/F),
select up/down, select-all, insert newline, Command Search, and Split
pane.

Co-Authored-By: Warp <agent@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants