search

CoatiSoftware / Sourcetrail

Sourcetrail - free and open-source interactive source explorer
https://www.sourcetrail.com/
GNU General Public License v3.0
14.94k stars 1.41k forks source link

Add content of "Help -> Fixing Errors" dialog to documentation #792

Open egraether opened 4 years ago

mlangkabel commented 4 years ago

@R-Ligier: Do you also want to take care of this issue while you are working on the documentation?

R-Ligier commented 4 years ago

Can I have a bit more context on what the issue is? @egraether @mlangkabel

mlangkabel commented 4 years ago

The Sourcetrail indexer may encounter errors while running. The first time this happens the user is prompted with a message box that explains what these errors are and what to do about it.

This GitHub issue asks to add the information from this dialog to the documentation as well. It just came to my mind because I was reading the part of our documentation about "Troubleshooting Errors" that you restructured in #816.

You can find the text of that dialog box at https://github.com/CoatiSoftware/Sourcetrail/blob/master/src/lib_gui/qt/view/QtErrorView.cpp#L99.

R-Ligier commented 4 years ago

Thank you for the additional information. Since i'm planning to do another phase of documentation edits, i'll include this issue with it.