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

docs: rewrite self-help instructions #2405

Merged
merged 2 commits into from
Jan 27, 2024
Merged

docs: rewrite self-help instructions #2405

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea9b222
docs: reword self-help instructions
rchl Jan 26, 2024
a0d8c2f
update issue template
rchl Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/src/troubleshooting.md
View file
Open in desktop
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nice
It would be good to add to the Issue: Bug report template as well. (bug_report.md)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean the whole text or link to that section? Or both? :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What you did in a0d8c2f suits me 👍

Usually when people fill issues,
they rarely provide logs,
so my initially comment is mostly "please provide some logs".

The added "Logs" section with a link to "Self-help instructions", will maybe direct someone to also provide a log when submitting an issue.


## Updating the PATH used by LSP servers

Expand Down