ISISNeutronMuon / MDANSE

MDANSE: Molecular Dynamics Analysis for Neutron Scattering Experiments
https://www.isis.stfc.ac.uk/Pages/MDANSEproject.aspx
GNU General Public License v3.0
21 stars 5 forks source link

Enhance Explanations in "Analysis: Dynamics," "Analysis: Structure," and "Analysis: Other Options" Sections #268

Open ashmeigh opened 10 months ago

ashmeigh commented 10 months ago

The "Analysis: Dynamics," "Analysis: Structure," and "Analysis: Other Options" sections of the "mdanse" documentation require improvement to provide users with clearer, more informative, and visually engaging content. This issue aims to enhance these sections by adding diagrams, improving the flow, and refining the writing.

Proposed Changes:

Review and assess the current content in the "Analysis: Dynamics," "Analysis: Structure," and "Analysis: Other Options" sections. Identify areas where explanations lack clarity, and content flow is disrupted. Enhance the explanations by: Adding diagrams, figures, or visual aids to illustrate key concepts. Ensuring a logical and smooth flow of information. Refining the writing to be concise and user-friendly.