-
Notifications
You must be signed in to change notification settings - Fork 1
initial commit of dev product guide docs #135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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 | |||
|
|
|||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 | |||
|
|
|||
There was a problem hiding this comment.
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.
…. Exceptions have been made in specific instances.
|
I'm merging your PR and migrating your doc to the Dev portal. After that, Kathy will review it and create a PR. |
initial commit of dev product guide docs
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.