add documentation for the neovim health check

zigtools · Dec 5, 2024 · 009d02a · 009d02a
1 parent 6f76eb2
commit 009d02a
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/content/zls/editors/vim/nvim-lspconfig.smd b/content/zls/editors/vim/nvim-lspconfig.smd
@@ -122,6 +122,16 @@ autocmd BufWritePre *.zig,*.zon lua vim.lsp.buf.format()
 EOF
 ```
 
+## Health Check
+
+To make sure that ZLS is set up as expected, open a `.zig` file and run the following health checks:
+
+```
+:checkhealth lspconfig vim.lsp
+```
+
+For more information on the health check, refer to [Health check](https://neovim.io/doc/user/health).
+
 ## Code Actions on save
 
 ### source.fixAll