Skip to content

Commit

Permalink
fix: Troubleshooting steps
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanlesage committed Dec 2, 2024
1 parent 71d7714 commit 516afba
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/en/getting-started/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Troubleshooting

Like any software, Zettlr might cause problem from time to time. This page contains instructions on how to resolve many of these issues. We have years of experience, and as such the options listed below should work in most cases.
Like any software, Zettlr might cause problems from time to time. This page contains instructions on how to resolve many of these issues, and also how to help the developers fix your issues faster, should they occur. We have years of experience, and as such the options listed below should work in most cases.

!!! note

Please attempt the steps listed here and consult [the FAQ](../reference/faq.md) first if you encounter any problems. If these steps do not solve your issue, please [ask our community](get-involved.md/#general-resources). If our community cannot help you as well, please open an issue on GitHub.
Please attempt the steps listed here and consult [the FAQ](../reference/faq.md) first if you encounter any problems. If these steps do not solve your issue, please [ask our community](get-involved.md/#general-resources). If our community cannot help you as well, please open an issue on GitHub. Read the instructions below to find out how to provide all information we need.

## 1. Try Turning it Off and On Again

Many problems can be solved by simply quitting Zettlr and restarting it. Sometimes, a restart of your computer might help, too.

!!! note

If you can reliably reproduce the problem, that is: the problem _always_ appears after you perform a specific action, this indicates that you've found a replicable bug. In that case, please provide us with a these steps when you open an issue.
If you can reliably reproduce the problem, that is: the problem _always_ appears after you perform a specific action, this indicates that you've found a replicable bug. In that case, please provide us with these steps when you open an issue.

## 2. Install the Most Recent Version

Many issues are fixed in newer versions. If you encounter an issue, make sure you have the most recent version installed.
Many issues are fixed in newer versions. If you encounter an issue, make sure you have the most recent version installed. To do so, go to "Help" → "Check for updates" and see if the app detects a new update. If you used a package manager to install Zettlr, use that one to update the app. You can always find the [most recent release on GitHub](https://github.com/Zettlr/Zettlr/releases).

## 3. Try Clearing the Cache

Expand Down Expand Up @@ -57,19 +57,26 @@ If you want to completely reset your local Zettlr installation, follow these ste

## 5. Ask the Community for Help

If none of the above steps seem to help, you can ask the community. Sometimes, someone else has encountered a similar problem and might be able to help you. The community is active both on [Discord](https://discord.gg/PcfS3DM9Xj) and on the [Zettlr subreddit](https://www.reddit.com/r/Zettlr).
If none of the above steps seem to help, you can ask the community. Sometimes, someone else has encountered a similar problem and might be able to help you. The community is active both on [Discord](https://go.zettlr.com/discord) and on the [Zettlr subreddit](https://www.reddit.com/r/Zettlr).

## 6. Open a GitHub Issue

If the community couldn't help you, or if it seems to be an actual bug, please open an issue on GitHub. Make sure to include as much information as possible so that we can quickly address the issue.
If the community couldn't help you, or if it seems to be an actual bug, please open an issue on GitHub. Make sure to include as much information as possible so that we can quickly address the issue. [Click here to open the form](https://github.com/Zettlr/Zettlr/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml) (GitHub account required). The form will ask the most important questions up front.

Make sure to include:

* A concise description of what happens, and what you expect to happen
* How can you trigger this issue? Be precise here so that we can reproduce the issue on our side
* Include screenshots or entire screencasts to demonstrate the issue. Very often, images "say more than a thousand words."
* Also provide log entries. You can find the logs by enabling the debug mode, then selecting "Develop" → "Open logs"

!!! note

If you open an issue on GitHub, make sure you receive notifications. We have follow-up questions almost always regarding your issue. The faster you respond, the faster we can fix your issue. If no one responds to your issue, this might indicate that we are not sure how to help you. In this case, it might help to rephrase the issue or add additional information.
If you open an issue on GitHub, make sure you receive notifications. We usually have follow-up questions regarding your issue. The faster you respond, the faster we can fix your issue. If no one responds to your issue, this might indicate that we are not sure how to help you. In this case, it might help to rephrase the issue or add additional information.

## 7. Revert to a previous version

Sometimes, an issue can hinder your productivity. Some users decide to revert to a previous version until we are able to fix the issue. We do not recommend this, as it can cause a host of other problems, so apply your judgment.
Sometimes, an issue can hinder your productivity. Some users decide to revert to a previous version until we are able to fix the issue. We do not recommend this, as it can cause a host of other problems, so do this at your own risk.

!!! warning

Expand Down

0 comments on commit 516afba

Please sign in to comment.