fix(docs): example (#227)

mistweaverco · Sep 9, 2024 · 37977a4 · 37977a4
1 parent ea1b276
commit 37977a4
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/docs/docs/getting-started/example-configuration.md b/docs/docs/getting-started/example-configuration.md
@@ -20,7 +20,7 @@ vim.api.nvim_buf_set_keymap(
   "n",
   "<CR>",
   "<cmd>lua require('kulala').run()<cr>",
-  { noremap = true, silent = true }
+  { noremap = true, silent = true, desc = "Execute the request" }
 )
 ```
 
@@ -34,14 +34,14 @@ vim.api.nvim_buf_set_keymap(
   "n",
   "[",
   "<cmd>lua require('kulala').jump_prev()<cr>",
-  { noremap = true, silent = true }
+  { noremap = true, silent = true, desc = "Jump to the previous request" }
 )
 vim.api.nvim_buf_set_keymap(
   0,
   "n",
   "]",
-  "<cmd>lua require('kulala').jump_nevt()<cr>",
-  { noremap = true, silent = true }
+  "<cmd>lua require('kulala').jump_next()<cr>",
+  { noremap = true, silent = true, desc = "Jump to the next request" }
 )
 ```
 
@@ -55,7 +55,7 @@ vim.api.nvim_buf_set_keymap(
   "n",
   "<leader>i",
   "<cmd>lua require('kulala').inspect()<cr>",
-  { noremap = true, silent = true }
+  { noremap = true, silent = true, desc = "Inspect the current request" }
 )
 ```
 
@@ -69,7 +69,7 @@ vim.api.nvim_buf_set_keymap(
   "n",
   "<leader>t",
   "<cmd>lua require('kulala').toggle_view()<cr>",
-  { noremap = true, silent = true }
+  { noremap = true, silent = true, desc = "Toggle between body and headers" }
 )
 ```
 
@@ -89,7 +89,7 @@ vim.api.nvim_buf_set_keymap(
   "n",
   "<leader>co",
   "<cmd>lua require('kulala').copy()<cr>",
-  { noremap = true, silent = true }
+  { noremap = true, silent = true, desc = "Copy the current request as a curl command" }
 )
 ```
 
@@ -110,6 +110,6 @@ vim.api.nvim_buf_set_keymap(
   "n",
   "<leader>ci",
   "<cmd>lua require('kulala').from_curl()<cr>",
-  { noremap = true, silent = true }
+  { noremap = true, silent = true, desc = "Paste curl from clipboard as http request" }
 )
 ```