Draft: Topic/which key upgrade (#44)

Author: ohdearaugustin

README.md

@@ -7,6 +7,7 @@ For the lazy, you can install my full config lazyvim with kube-utils-nvim instal
 This Neovim plugin provides seamless integration with Kubernetes and Helm, allowing you to deploy and manage Kubernetes resources directly from your editor.
 
 ## Features
+
 - **Kubernetes Context and Namespace Management**: Easily switch between different Kubernetes contexts and namespaces.
 - **CRD Viewer:** View Custom Resource Definitions directly in Neovim.
 - **Helm Integration:** Manage Helm charts, update dependencies, and deploy directly from Neovim.
@@ -16,17 +17,19 @@ This Neovim plugin provides seamless integration with Kubernetes and Helm, allow
 - **K9s Integration:** Open k9s from nvim
 
 #### Screenshots
+
 Here are some visual previews of the plugin in action
 
 Telescope NS selector :
+
 - ![Screenshot 1](https://github.com/h4ckm1n-dev/kube-utils-nvim/assets/97511408/bbfe3a51-6117-413f-9d31-9f66517994c2)
-K9S module:
+  K9S module:
 - ![Screenshot 2](https://github.com/h4ckm1n-dev/kube-utils-nvim/assets/97511408/c6139ddf-e9af-4665-bd57-a829b236bac2)
-K9S in a vertical split view :
+  K9S in a vertical split view :
 - ![Screenshot 3](https://github.com/h4ckm1n-dev/kube-utils-nvim/assets/97511408/8c3cbaf8-d3c0-44a8-b487-4858e06b86f7)
-Get CRD function :
+  Get CRD function :
 - ![Screenshot 4](https://github.com/h4ckm1n-dev/kube-utils-nvim/assets/97511408/b5c1158e-5c93-41aa-b9ee-6fa5e2d0cb2b)
-Get Log and FormatJson :
+  Get Log and FormatJson :
 - ![image](https://github.com/h4ckm1n-dev/kube-utils-nvim/assets/97511408/52c7ecc8-9bb7-4dc0-a0cb-8e886d4ce645)
 
 ![Capture Video Preview](https://github.com/h4ckm1n-dev/kube-utils-nvim/assets/97511408/d575048c-2f88-415a-a62f-90db935d6951)
@@ -47,48 +50,40 @@ return {
 }
 
 ```
+
 ## Key Bindings
+
 Use the following mappings to access Kubernetes features efficiently:
-```lua
-local helm_mappings = {
-  k = {
-    name = "Kubernetes", -- Main title for all Kubernetes related commands
-
-    -- Helm Commands
-    h = {
-      name = "+Helm",
-      d = { "<cmd>HelmDeployFromBuffer<CR>", "Helm Deploy Buffer to Context" },
-      r = { "<cmd>RemoveDeployment<CR>", "Helm Remove Deployment From Buffer" },
-      T = { "<cmd>HelmDryRun<CR>", "Helm DryRun Buffer" },
-      u = { "<cmd>HelmDependencyUpdateFromBuffer<CR>", "Helm Dependency Update" },
-      b = { "<cmd>HelmDependencyBuildFromBuffer<CR>", "Helm Dependency Build" },
-      t = { "<cmd>HelmTemplateFromBuffer<CR>", "Helm Template From Buffer" },
-    },
-
-    -- Kubectl Commands
-    k = {
-      name = "+Kubectl",
-      a = { "<cmd>KubectlApplyFromBuffer<CR>", "Kubectl Apply From Buffer" },
-      D = { "<cmd>DeleteNamespace<CR>", "Kubectl Delete Namespace" },
-      K = { "<cmd>OpenK9s<CR>", "Open K9s" },
-      k = { "<cmd>OpenK9sSplit<CR>", "Split View K9s" },
-      l = { "<cmd>ToggleYamlHelm<CR>", "Toggle YAML/Helm" },
-      c = { "<cmd>SelectCRD<CR>", "Download CRD" },
-      C = { "<cmd>SelectSplitCRD<CR>", "Download CRD Split" },
-    },
-
-    -- Logs Commands
-    l = {
-      name = "+Logs",
-      f = { "<cmd>JsonFormatLogs<CR>", "Format JSON" },
-      v = { "<cmd>ViewPodLogs<CR>", "View Pod Logs" },
-    },
-  },
-}
 
--- Register the Helm keybindings with a specific prefix
-require('which-key').register(helm_mappings, { prefix = "<leader>" })
+```lua
+local kube_utils_mappings = {
+  { "<leader>k", group = "Kubernetes" }, -- Main title for all Kubernetes related commands
+  -- Helm Commands
+  { "<leader>kh", group = "Helm" },
+  { "<leader>khT", "<cmd>HelmDryRun<CR>", desc = "Helm DryRun Buffer" },
+  { "<leader>khb", "<cmd>HelmDependencyBuildFromBuffer<CR>", desc = "Helm Dependency Build" },
+  { "<leader>khd", "<cmd>HelmDeployFromBuffer<CR>", desc = "Helm Deploy Buffer to Context" },
+  { "<leader>khr", "<cmd>RemoveDeployment<CR>", desc = "Helm Remove Deployment From Buffer" },
+  { "<leader>kht", "<cmd>HelmTemplateFromBuffer<CR>", desc = "Helm Template From Buffer" },
+  { "<leader>khu", "<cmd>HelmDependencyUpdateFromBuffer<CR>", desc = "Helm Dependency Update" },
+  -- Kubectl Commands
+  { "<leader>kk", group = "Kubectl" },
+  { "<leader>kkC", "<cmd>SelectSplitCRD<CR>", desc = "Download CRD Split" },
+  { "<leader>kkD", "<cmd>DeleteNamespace<CR>", desc = "Kubectl Delete Namespace" },
+  { "<leader>kkK", "<cmd>OpenK9s<CR>", desc = "Open K9s" },
+  { "<leader>kka", "<cmd>KubectlApplyFromBuffer<CR>", desc = "Kubectl Apply From Buffer" },
+  { "<leader>kkc", "<cmd>SelectCRD<CR>", desc = "Download CRD" },
+  { "<leader>kkk", "<cmd>OpenK9sSplit<CR>", desc = "Split View K9s" },
+  { "<leader>kkl", "<cmd>ToggleYamlHelm<CR>", desc = "Toggle YAML/Helm" },
+  -- Logs Commands
+  { "<leader>kl", group = "Logs" },
+  { "<leader>klf", "<cmd>JsonFormatLogs<CR>", desc = "Format JSON" },
+  { "<leader>klv", "<cmd>ViewPodLogs<CR>", desc = "View Pod Logs" },
+
+-- Register the Kube Utils keybindings
+require('which-key').add(kube_utils_mappings)
 ```
+
 ## Requirements
 
 - Neovim 0.9.0 or higher