docs: rewrite self-help instructions #2405
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for sublime-lsp canceled.
|
|
|
||
| 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. |
There was a problem hiding this comment.
This is nice
It would be good to add to the Issue: Bug report template as well. (bug_report.md)
There was a problem hiding this comment.
You mean the whole text or link to that section? Or both? :)
There was a problem hiding this comment.
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.
predragnikolic
approved these changes
Jan 27, 2024
predragnikolic
approved these changes
Jan 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rewritten self-help instructions.
I wanted it to be something that we can link people to when asking for additional information without having to repeat ourselves all the time. The old text was a bit all over the place. Now it's hopefully more precise and concise and will get us the stuff we need.
Feel free to suggest improvements as english is not my forte and I'm not particularly good at writing docs. :)
(we can potentially even link to it in an issue template)