Documentation issues/enhancements

[klmcadams]

Description of the modifications

These are issues and enhancements that could make this page of the docs better: https://mechanical.docs.pyansys.com/version/stable/

Issues

• [x] The PyAnsys link is broken
• [x] Remove "Project Index" and bullet point at the end
• [x] The PyMechanical Documentation link points to itself (circular link)

Enhancements (just ideas - up to discussion)

• [ ] Explain how pymechanical is different than using Mechanical - this is kind of done in the Introduction section
• [ ] Include a diagram or two to show how things work?
• [x] Add setup or installation information for pymechanical towards the top of the page
• [ ] Add a small usage example on the page
  • we can then say for more examples, see the Examples link

I think it would be beneficial to combine the landing page with the "Getting Started" tab in the docs. That way, when people visit our site they have everything they need in front of them to get started, and from that base information, we can link supplementary help & info that can be accessed in the other tabs

Useful links and references

https://mechanical.docs.pyansys.com/version/stable/

• [ ] Include this youtube video as a brief tutorial: https://youtu.be/a72Wxj-xL4Q?feature=shared&t=314

[pmaroneh]

Hi @klmcadams , I believe these are good suggestions. In terms of additional explanation and adding diagrams, I find that these two are helfpul with customer interactions:

• difference between in-product and PyAnsys scripting:
• difference between embedded and remote PyMechanical: If you think these might help, I'm happy to share the editable version of these pics with you.

[klmcadams]

@pmaroneh Sure, those would be great! Thanks!