Add some documentation for Helix mode (#35641)

ponychicken , ponychicken , and Ben Kunkle created 3 months ago

Because there is literally no mention of it in the docs

Release Notes:

- N/A

---------

Co-authored-by: ponychicken <[e-mail]>
Co-authored-by: Ben Kunkle <[e-mail]>

Change summary

docs/src/SUMMARY.md         |  1 +
docs/src/configuring-zed.md |  8 +++++++-
docs/src/helix.md           | 11 +++++++++++
docs/src/key-bindings.md    |  4 ++--
4 files changed, 21 insertions(+), 3 deletions(-)

Detailed changes

docs/src/SUMMARY.md

@@ -21,6 +21,7 @@
 - [Icon Themes](./icon-themes.md)
 - [Visual Customization](./visual-customization.md)
 - [Vim Mode](./vim.md)
+- [Helix Mode](./helix.md)
 
 <!-- - [Globs](./globs.md) -->
 <!-- - [Fonts](./fonts.md) -->

docs/src/configuring-zed.md

@@ -3195,10 +3195,16 @@ Run the `theme selector: toggle` action in the command palette to see a current
 
 ## Vim
 
-- Description: Whether or not to enable vim mode (work in progress).
+- Description: Whether or not to enable vim mode. See the [Vim documentation](./vim.md) for more details on configuration.
 - Setting: `vim_mode`
 - Default: `false`
 
+## Helix Mode
+
+- Description: Whether or not to enable Helix mode. Enabling `helix_mode` also enables `vim_mode`. See the [Helix documentation](./helix.md) for more details.
+- Setting: `helix_mode`
+- Default: `false`
+
 ## Project Panel
 
 - Description: Customize project panel

docs/src/helix.md

@@ -0,0 +1,11 @@
+# Helix Mode
+
+_Work in progress! Not all Helix keybindings are implemented yet._
+
+Zed's Helix mode is an emulation layer that brings Helix-style keybindings and modal editing to Zed. It builds upon Zed's [Vim mode](./vim.md), so much of the core functionality is shared. Enabling `helix_mode` will also enable `vim_mode`.
+
+For a guide on Vim-related features that are also available in Helix mode, please refer to our [Vim mode documentation](./vim.md).
+
+To check the current status of Helix mode, or to request a missing Helix feature, checkout out the ["Are we Helix yet?" discussion](https://github.com/zed-industries/zed/discussions/33580).
+
+For a detailed list of Helix's default keybindings, please visit the [official Helix documentation](https://docs.helix-editor.com/keymap.html).

docs/src/key-bindings.md

@@ -14,7 +14,7 @@ If you're used to a specific editor's defaults you can set a `base_keymap` in yo
 - TextMate
 - None (disables _all_ key bindings)
 
-You can also enable `vim_mode`, which adds vim bindings too.
+You can also enable `vim_mode` or `helix_mode`, which add modal bindings. For more information, see the documentation for [Vim mode](./vim.md) and [Helix mode](./helix.md).
 
 ## User keymaps
 
@@ -119,7 +119,7 @@ It's worth noting that attributes are only available on the node they are define
 
 Note: Before Zed v0.197.x, the ! operator only looked at one node at a time, and `>` meant "parent" not "ancestor". This meant that `!Editor` would match the context `Workspace > Pane > Editor`, because (confusingly) the Pane matches `!Editor`, and that `os=macos > Editor` did not match the context `Workspace > Pane > Editor` because of the intermediate `Pane` node.
 
-If you're using Vim mode, we have information on how [vim modes influence the context](./vim.md#contexts)
+If you're using Vim mode, we have information on how [vim modes influence the context](./vim.md#contexts). Helix mode is built on top of Vim mode and uses the same contexts.
 
 ### Actions