Documentation on Emacs is incomplete

[Techatrix]

Related Issue for Neovim/Vim: #2

Installation Guide

Most of these issues apply to GNU Emacs, Doom Emacs and Spacemacs

• document how to manually specify the path to Zig and ZLS
• document how to use lsp-mode and eglot for every emacs variant instead of favoring one over the other.
• document how to set ZLS config options (already done for GNU Emacs)
• link to official documentation from lsp-mode, eglot, etc. on how to setup and configure an LSP

lsp-mode and eglot should have their own subpage to document anything specific to them that isn't also tied to a emacs variant.

The documentation should have a similar structure and wording to the existing docs for editors. Helix and Neovim can be used as a reference point.

How to view ZLS log output Guide

• add guide for eglot (if possible)
• add link to Troubleshooting Eglot

[aerphanas]

i use Eglot in emacs, i want to make PR but last open PR is #15 on Feb 17, 2025

automatically start eglot when zig-mode start

(use-package eglot
  :hook ((zig-mode  . eglot-ensure))

In-Editor Config

eglot support workspace configuration (scema.json) see eglot/5.2 User-specific configuration

(use-package eglot
  :hook (zig-mode  . eglot-ensure))
  :config
  (setq-default eglot-workspace-configuration
                '(:zls (:inlay_hints_show_parameter_name :json-false
                        :warn-style t))))

Custom ZLS & Zigpath

setup custom ZLS path see eglot/2.1 Setting Up LSP Servers

(use-package eglot
  :hook (zig-mode  . eglot-ensure))
  :config
  (add-to-list 'eglot-server-programs
               '(zig-mode . ("/home/arpnsh/Projects/archive/zls")))
  (setq-default eglot-workspace-configuration
                '(:zls (:inlay_hints_show_parameter_name :json-false
                        :warn-style t
                        :zig_exe_path "/home/arpnsh/Projects/archive/Zig/zig-root/zig"))))

[Techatrix]

You are welcome to send a PR anytime even if there are unreviewed PRs lying around.

The docs you provided look similar to what can be found on the GNU Emacs page tho. The usage of eglot-workspace-configuration and links to official eglot documentation could still be of use.

I will update the issue description to better reflect the current status.