Skip to content

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Nov 30, 2022

Added the faq section and did some basic clean up that begins to align the doc with the Google developer style guidelines.

@PipKat PipKat added the documentation Documentation related (improving, adding, etc) label Dec 1, 2022
@PipKat PipKat requested a review from dnwillia-work December 1, 2022 15:30
@PipKat
Copy link
Member Author

PipKat commented Dec 1, 2022

@dnwillia I've incorporated the info from the FAQ PPT that Nima Bohlooli Arkhazloo shared with me as a new page in the "Getting started" section of the PyFluent documentation. I did have to convert it from the bulleted list format in the original PPT source to the complete sentence style required by the Google developer style guide and Vale style checks. I also have more installation information from a PPT shared with me by Pablo Aguado but will consider adding content from it to the existing installing in the PyFluent documentation in a separate PR next week.

@PipKat PipKat requested a review from rploconnor December 2, 2022 13:39
@PipKat
Copy link
Member Author

PipKat commented Dec 2, 2022

@seanpearsonuk All excellent points! I've added Ryan O'Conner as a reviewer because he and Nima supplied the basic content. Nima doesn't seem to have write access to this repo, so I can't add him as a reviewer. However, Ryan can.

@PipKat
Copy link
Member Author

PipKat commented Dec 5, 2022

@seanpearsonuk @dnwillia-work Any change of getting the remaining conversations resolved and this PR merged soon?
@rploconnor Do you have time to do a review and approval?

@PipKat PipKat merged commit c43eec5 into main Dec 6, 2022
@PipKat PipKat deleted the doc/add_FAQ_section branch December 6, 2022 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation related (improving, adding, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants