Troubleshooting

If you encounter unknown errors or exceptions while using MrDoc, but cannot identify the cause, you can follow the steps below to troubleshoot. This helps avoid ineffective communication and saves everyone’s time.

## 0. Make Good Use of Translation and Search Tools

For error messages in English, make good use of:

* Search engines (Baidu [https://www.baidu.com](https://www.baidu.com), Bing [http://www.bing.com](http://www.bing.com), Google [http://www.google.com](http://www.google.com))
* AI assistants (Deepseek [https://chat.deepseek.com/](https://chat.deepseek.com/), Doubao [https://www.doubao.com/chat](https://www.doubao.com/chat), ChatGPT [https://chatgpt.com/](https://chatgpt.com/))

to understand error messages and find possible solutions.

If the problem persists, follow the steps below to obtain detailed error information for feedback.

## 1. Enable Debug Mode

Enable `debug` mode in the configuration file. When an error occurs on the page (e.g., 500 Internal Server Error), detailed error information will be displayed.

Configuration file details: [https://doc.mrdoc.pro/doc/3990/](https://doc.mrdoc.pro/doc/3990/)

## 2. Check Browser Developer Console

On the page showing the error, right-click and select "Inspect" to open the browser developer console.

Check the **Console** tab for any error messages:

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/04/20/2023-04-20_104458_2624190.9230515041405257.png)

You can also check the **Network** tab to find related failing requests and click the request URL to view the response details:

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/04/20/2023-04-20_104643_6248900.054060900972025094.png)

## 3. Check Logs

You can also check logs to understand the cause of the failure.

MrDoc log viewing documentation: [https://doc.mrdoc.pro/doc/45444/](https://doc.mrdoc.pro/doc/45444/)

## 4. Issue Feedback Template

If you want to report an issue to seek help, please provide complete and detailed information to avoid wasting everyone’s time and effort. Include but not limited to:

```
### 0. What is the deployment method?

### 1. What is the current MrDoc version?

### 2. What database are you using?

### 3. What is the URL/path of the page where the issue occurs?

### 4. What are the steps to reproduce the issue?

### 5. Can the issue be reproduced consistently?

### 6. Is the issue isolated or widespread?

### 7. What is the operating system and browser version?

### 8. If available, please provide relevant logs.

### 9. If available, please provide screenshots.

### 10. If available, please provide video recordings.

### 11. If the issue relates to a knowledge base, provide the knowledge base and its configuration.

### 12. If the issue relates to a document, provide the document and its configuration.

### 13. If the issue relates to a user, provide user info and site user configuration.

### 14. If the issue relates to media assets, provide media and storage-related configurations.
```

---

Let me know if you want me to continue!