docs: Getting Started & ecosystem links#1655
Merged
Merged
Conversation
I am currently working on reviewing and improving PyAnsys Getting Started sections and this work is part of that. It is reasonable to assume new users of PyMechanical will be familiar with Python and pip but not guaranteed. So I have added a note + link that makes it clearer what those items are for people that don't know when they first get mentioned in the docs. In addition, I have added a section on the Ansys wider developer ecosystem to the troubleshooting section including a set of links to places where users can expect to find resources that may be of assistance, such as the portal, forum AIS, ALH, etc. I have not been able to fully build the docs with the changes locally because I do not have Mechanical installed, however, the changes are sufficiently small that a code review should suffice.
Up to standards ✅🟢 Issues
|
…ys/pymechanical into docs/improve_getting_started
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1655 +/- ##
=======================================
Coverage 80.69% 80.69%
=======================================
Files 43 43
Lines 3321 3321
=======================================
Hits 2680 2680
Misses 641 641 🚀 New features to boost your workflow:
|
dipinknair
reviewed
Jun 12, 2026
dipinknair
reviewed
Jun 12, 2026
dipinknair
reviewed
Jun 12, 2026
dipinknair
reviewed
Jun 12, 2026
Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com>
Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com>
Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com>
Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com>
dipinknair
reviewed
Jun 12, 2026
dipinknair
requested changes
Jun 12, 2026
Co-authored-by: Dipin <26918585+dipinknair@users.noreply.github.com>
Contributor
Author
|
all suggestions applied! |
dipinknair
approved these changes
Jun 12, 2026
Contributor
|
@jgd10 Thanks James for the contribution ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I am currently working on reviewing and improving PyAnsys Getting Started sections and this work is part of that. It is reasonable to assume new users of PyMechanical will be familiar with Python and pip but not guaranteed. So I have added a note + link that makes it clearer what those items are for people that don't know when they first get mentioned in the docs.
In addition, I have added a section on the Ansys wider developer ecosystem to the troubleshooting section including a set of links to places where users can expect to find resources that may be of assistance, such as the portal, forum AIS, ALH, etc.
I have not been able to fully build the docs with the changes locally because I do not have Mechanical installed, however, the changes are sufficiently small that a code review should suffice.
Changes
Type of change
Checklist
feat: add modal analysis support)