Update FAQ

[lilyminium]

If you have encountered any problems while working with MDAnalysis, and you do not see the problem and solution on the MDAnalysis FAQ (https://userguide.mdanalysis.org/stable/faq.html), please help us update our documentation by opening a pull request! The contribution should consist of:

• a heading summarising the problem or question
• (Optionally) more detail about the problem, possibly with examples or error messages
• An answer or solution. You don't need to come up with this yourself! Please email the MDAnalysis mailing list (https://groups.google.com/group/mdnalysis-discussion) or open an issue at the main repository (https://github.com/MDAnalysis/mdanalysis/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) if you need help.

The user guide contains a section on contributing here: https://userguide.mdanalysis.org/stable/contributing_docs.html

[orbeckst]

You can also look through the mailing list archives and see if there are issues that come up repeatedly. If you summarize the problem as a entry for the FAQ then we can also add any solutions from the mailing list and in the future everyone can look at the FAQ.

If there are problems that come up repeatedly on the mailinglist and there has never been a solution posted then that's something we would definitely want to know, too!

[nancyalaswad90]

.

HI @lilyminium

**Please clear steps here for me , when I begin working should I : **

1. Fork this repository as I did

2). update our documentation by opening a pull request that contain

more detail about the problem, possibly with examples or error messages

Do you mean add explanations for ideas I understand about the problem (( summarize my work through while working with MDAnalysis)) by some mark down ideas and terms

[lilyminium]

Hi @nancyalaswad90! Apologies for taking so long to answer, I did not get a notification for this. You should fork the user guide repository and follow the steps here: https://userguide.mdanalysis.org/stable/contributing_docs.html

"more detail about the problem, possibly with examples or error messages" means specific errors that you encounter while using MDAnalysis. If we can fix them and it's a common problem, we should put that on the user guide so other people can see the solution.

[nancyalaswad90]

So grateful for your response, I will follow all your instructions 🌺

On Thu, Apr 14, 2022, 11:54 AM Lily Wang @.***> wrote:

Hi @nancyalaswad90 https://github.com/nancyalaswad90! Apologies for taking so long to answer, I did not get a notification for this. You should fork the user guide repository and follow the steps here: https://userguide.mdanalysis.org/stable/contributing_docs.html

"more detail about the problem, possibly with examples or error messages" means specific errors that you encounter while using MDAnalysis. If we can fix them and it's a common problem, we should put that on the user guide so other people can see the solution.

— Reply to this email directly, view it on GitHub https://github.com/MDAnalysis/UserGuide/issues/192#issuecomment-1098879858, or unsubscribe https://github.com/notifications/unsubscribe-auth/AIUIQI5ZOVU2Y5BHD3O54B3VE7MMDANCNFSM5R74E4WA . You are receiving this because you were mentioned.Message ID: @.***>

[lilyminium]

https://github.com/MDAnalysis/mdanalysis/issues/3860 this is a very common question that has a multi-faceted answer.