Skip to content

Conversation

@jgd10
Copy link
Contributor

@jgd10 jgd10 commented Mar 26, 2025

Developer Product Guide, ready for review. There are some deviations from standard style and formatting that are deliberate, although I suspect there may be some that are not as well.

I consider "Ansys Developer" to be akin to a product title and thus must be capitalised.

I have tried to match product collection with the collections on ansys.com, however there are two notable, and deliberate, exceptions.

  1. I have combined Electronics & Semiconductors into a single collection. This is because there are products in both categories that operate in tandem with PyAEDT, and so it makes sense for all these products to be on the same page as PyAEDT and also means that PyAEDT doesn't fit into either category.
  2. There is the "Miscellaneous" category for tools that do not correspond to a product or otherwise do not have a product family. DPF is a great example of this and PyPrimeMesh as well. These are not products and can not be found in product collections, but are of sufficient importance that they need to be accounted for.

@jgd10 jgd10 requested review from AnsMelanie and PipKat March 26, 2025 18:24
Copy link
Collaborator

@AnsMelanie AnsMelanie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use Vale to ensure compliance with Google rules, it would be helpful.

I also provided some general comments that apply to other content as well. Additionally, I believe the AVx section could be more comprehensive, as it currently does not fully cover AVx sensors and AVx autonomy.

Also rebase your repository to align with the main repository, as I have removed a significant amount of content that is still present in your branch.

@@ -0,0 +1,36 @@
# 3D Design

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add an introduction to each MD file corresponding to a collection. Below is an example:
This section provides a list of all Ansys products included in the 3D Design collection and specifies whether developer materials are available for each product.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there worth in adding boilerplate like that though? That statement is already present on the homepage. We're not expecting viewers to be reading through this document, rather it is intended to operate like a glossary or reference book where people search for the term they want and/or are interested in, go there and read about it, and then leave.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I get your point! I agree, let's leave the pages without an intro and focus on making the content easily navigable for quick access to information.


## SpaceClaim

### Ansys SpaceClaim Training Material
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please convert Training Material into training material. Do this for all titles in general but also in the doc.

@@ -0,0 +1,15 @@
# Acoustics Analysis

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding an introduction would help users.

@AnsMelanie
Copy link
Collaborator

I'm merging your PR and migrating your doc to the Dev portal. After that, Kathy will review it and create a PR.

@AnsMelanie AnsMelanie merged commit 58d9590 into main Mar 28, 2025
4 checks passed
@AnsMelanie AnsMelanie deleted the DevProductGuide branch April 2, 2025 12:45
AnsMelanie added a commit that referenced this pull request Jul 11, 2025
initial commit of dev product guide docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants