ansys / ansys-tools-local-product-launcher

A utility for launching Ansys products on the local machine
https://local-product-launcher.tools.docs.pyansys.com
MIT License
2 stars 0 forks source link

Overall doc review for public release #143

Closed PipKat closed 9 months ago

PipKat commented 9 months ago

Because "entrypoint" was used almost three times as frequently as "entry point," I changed all occurrences to"entrypoint" descriptive text . Otherwise, I reorganized the README and doc landing page to follow the conventions we've adopted recently. Our overall goal is to provide information (such as installation) in one place only and then reference that place from elsewhere.

The links in the README to the doc sections now point to the dev doc folder so that they work. However, prior to release, they will have to be changed to the stable doc folder.

@RobPasMue I've marked the doc review as completed in Issue #130. You can merge this PR as is or first address my very few comments and then merge.

greschd commented 9 months ago

Thanks a lot for the review @PipKat. It looks good overall from my side; I've just added some minor tweaks.

PipKat commented 9 months ago

@RobPasMue @greschd Thanks so much for your thorough review. You caught quite a few errors on my part, which is much appreciated! @greschd I'll let you resolve the last few comments and merge this PR when you are fully satisfied with it!

greschd commented 9 months ago

Thanks again for your review @PipKat! Awesome work 🎉