[JOSS REVIEW] Improve description in examples

[finsberg]

I must first say that I really like the way you have created the examples. It is really cool with both the pyvista integration and the "Download buttons" at the end. Really nice job!

I think however that some of the examples could be improved by providing some more text explaining the different examples, preferable with the necessary mathematical background and references to papers. For example in Displacement control there are not really any text explaining what this example is about, and it seems to be some headings and text that are copy-pasted from other examples.

Instead of creating a separate issue for each example I create this one as a general issue for all of them, and then you can go through the examples and make sure that each example reads as a coherent piece of text.

This issue is related to the review here: openjournals/joss-reviews#7307

[CastillonMiguel]

I’m currently working on revising the examples and adding more detailed text, including necessary references and a clearer explanation of each example's purpose.
To keep track of the progress, I’m planning to address each examples section , and here’s a list of sections that I’ve revised or am working on revising:

• AllenCahn: 823c48c
• Elasticity: 6308f86
• Fatigue: c6f8b60
• GmshGeoFiles e870130
• PhaseField: e79cd38
• PhaseFieldFracture a1deeb6

I’ll update the examples to ensure they form coherent, self-contained explanations.
Thanks again for your input!

edit: I’ve updated the GmshGeoFiles section
edit2 : I’ve updated the PhaseFieldFracture/Fatigue section

[finsberg]

Looks very good! A few minor things

• The plot at the end here is not showing.
• Some text on this page looks now well formatted.

[CastillonMiguel]

Thanks for the feedback! I’ve resolved the plot display issue and improved text formatting in that file and across other related files for better readability