Skip to content

Commit

Permalink
docs: rewrite self-help instructions (#2405)
Browse files Browse the repository at this point in the history
  • Loading branch information
rchl authored Jan 27, 2024
1 parent 3400acc commit 3561214
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
11 changes: 10 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,41 @@ about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**

Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**

A clear and concise description of what you expected to happen.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Logs**

Check https://lsp.sublimetext.io/troubleshooting/#self-help-instructions on how to provide additional logs.

**Environment (please complete the following information):**

- OS: [e.g. Ubuntu 20.04 or macOS 10.15]
- Sublime Text version: [e.g. 4085]
- LSP version: [e.g. 1.0.12, run `Package Control: List Packages` to find the version]
- Language servers used: [e.g. clangd, gopls, dart, Vetur, intelephense, HIE]

**Additional context**

Add any other context about the problem here. For example, whether you're using a helper
package or your manual server configuration in LSP.sublime-settings. When using
a manual server configuration please include it here if you believe it's applicable.
12 changes: 6 additions & 6 deletions docs/src/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Self-help instructions

To see the LSP server and client communication, run `LSP: Toggle Log Panel` from the Command Palette. Logs are useful to diagnose problems.
Following are the primary places to look at when diagnosing issues:

!!! note
It might be a good idea to restart Sublime Text and reproduce the issue again so that the logs are clean.

If you believe the issue is with this package, please include the output from the Sublime console in your issue report!
1. Run `LSP: Toggle Log Panel` from the *Command Palette* to see communication logs between the server and the client. It allows to see what the server is doing exactly.
2. Open the *Sublime Text* console by going to `View` -> `Show Console` from the main menu. It provides information about installed packages, potential LSP crashes and additional LSP debugging logs when `log_debug` is enabled in `Preferences: LSP Settings`.
3. Focus the relevant file, then run `LSP: Troubleshoot server` from the *Command Palette* and select a server to see troubleshooting information. It can be a very efficient way to diagnose problems quickly when shared.

If the server is crashing on startup, try running `LSP: Troubleshoot server` from the Command Palette and check the "Server output" for potential errors. Consider sharing the output of this command in the report.
!!! note
In case of reporting an issue, consider providing all before-mentioned logs. If you can reproduce the issue, then restarting Sublime Text before capturing the logs can help improve clarity of the logs.

## Updating the PATH used by LSP servers

Expand Down

0 comments on commit 3561214

Please sign in to comment.