Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation on Emacs is incomplete #1

Open
2 of 6 tasks
Techatrix opened this issue Jul 23, 2024 · 0 comments
Open
2 of 6 tasks

Documentation on Emacs is incomplete #1

Techatrix opened this issue Jul 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Techatrix
Copy link
Member

Techatrix commented Jul 23, 2024 •
edited
Loading

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 instead of favoring one over the other. (Doom Emacs and Spacemacs are lsp-mode only I believe)
  • document how to set ZLS config options (if possible)
  • link to official documentation from lsp-mode, eglot, etc. on how to setup and configure an LSP

The documentation should be closer to what is already provided for Sublime Text 4 or nvim-lspconfig as an example.

How to view ZLS log output Guide
@Techatrix Techatrix added the documentation Improvements or additions to documentation label Jul 23, 2024
@Techatrix Techatrix mentioned this issue Jul 23, 2024
Open
9 tasks
@Techatrix Techatrix transferred this issue from zigtools/zls Aug 21, 2024
Techatrix added a commit that referenced this issue Nov 14, 2024
@Techatrix
overhaul ZLS documentation
543a7f4 
- split documentation into separate pages
- update editor configuration (every single one, no exceptions)
- add documentation for zls.json JSON Schema
- add documentation for Zed
- add documentation for Code Actions
- add "Build-On-Save" Guide
- add "View Logs" Guide
- add table of contents as a sidebar
- clearly document support for in-editor configuration for each Editor
- mark Emacs Documentation as incomplete #1
- minor styling changes

fixes #6
Techatrix added a commit that referenced this issue Nov 17, 2024
@Techatrix
document how to view logs for Eglot in Emacs
c97eec3 
See  #1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Techatrix