Skip to content
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.

Sign up for GitHub

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

Jump to bottom

maint: documentation review #44

Merged
merged 19 commits into from
Feb 23, 2024
Merged

maint: documentation review #44

merged 19 commits into from
Feb 23, 2024

Conversation

clatapie
Copy link
Contributor

Closes #43.

@clatapie clatapie linked an issue Feb 16, 2024 that may be closed by this pull request
maint: documentation review #43
Closed
@PipKat
Copy link
Member

PipKat commented Feb 16, 2024 •
edited
Loading

@clatapie I've finished reviewing the existing doc content. The biggest change was to redo the README in our new format and consolidate user installation info in the "Getting started" section and developer installation info in the "Contribute" section. I would like to quickly review whatever content is added soon for the "User guide" section.

@clatapie
Copy link
Contributor Author

clatapie commented Feb 19, 2024 •
edited by PipKat
Loading

Thank you @PipKat for your time and for your prompt feedback on the documentation!
Regarding the User guide section, I am pinging the @ansys/modelcenter-team for visibility.

clatapie
clatapie commented Feb 19, 2024
View reviewed changes
README.rst Outdated Show resolved Hide resolved
RobPasMue
RobPasMue previously approved these changes Feb 20, 2024
View reviewed changes
@clatapie
Copy link
Contributor Author

clatapie commented Feb 20, 2024 •
edited by RobPasMue
Loading

To do before merging:

  • removing the TODO list in the README.rst file after having checked each task
  • completing the User Guide section

@mike-belcher @RobPasMue
Add link in user guide referring to PyModelCenter. (#46)
126ff41 
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
RobPasMue
RobPasMue previously approved these changes Feb 21, 2024
View reviewed changes
@clatapie clatapie requested a review from PipKat February 21, 2024 09:20
@clatapie @PipKat
Update doc/source/user_guide/index.rst
c5b1df2 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@clatapie @PipKat
Update doc/source/user_guide/index.rst
1e88b6d 
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@clatapie clatapie requested a review from PipKat February 22, 2024 17:17
PipKat
PipKat approved these changes Feb 22, 2024
View reviewed changes
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks, @clatapie.

@RobPasMue RobPasMue mentioned this pull request Feb 23, 2024
Closed
@RobPasMue RobPasMue merged commit 18ba21d into main Feb 23, 2024
20 checks passed
@RobPasMue RobPasMue deleted the maint/doc_review branch February 23, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RobPasMue RobPasMue RobPasMue approved these changes

@PipKat PipKat PipKat approved these changes

Assignees

@PipKat PipKat

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

maint: documentation review
4 participants
@clatapie @PipKat @RobPasMue @mike-belcher