Doc/overall review

[PipKat]

@Revathyvenugopal162 I moved the content from the README.MD file to the doc RST files. I also created a new README.RST file. Will the repo know to display it once this PR is merged. I couldn't find any place where the file to show for the repository was specified but was worried that a change might be needed for this. I have a few comments inline as well. Also, I can't run Vale locally. I get this message:
E100 [vocab] Runtime error

'ANSYS' does not exist

I used the git clean -f -d -x doc command to clean the doc directory, thinking it would fix the issue, but it didn't. Do you know what Vale can't find the ANSYS directory, which is here: C:\AnsysDev\GitRepos\PyAnsys\pyansys-quarto-cheatsheet\doc\styles\config\vocabularies\ANSYS

[Revathyvenugopal162]

@Revathyvenugopal162 I moved the content from the README.MD file to the doc RST files. I also created a new README.RST file. Will the repo know to display it once this PR is merged. I couldn't find any place where the file to show for the repository was specified but was worried that a change might be needed for this. I have a few comments inline as well. Also, I can't run Vale locally. I get this message: E100 [vocab] Runtime error

'ANSYS' does not exist

I used the git clean -f -d -x doc command to clean the doc directory, thinking it would fix the issue, but it didn't. Do you know what Vale can't find the ANSYS directory, which is here: C:\AnsysDev\GitRepos\PyAnsys\pyansys-quarto-cheatsheet\doc\styles\config\vocabularies\ANSYS

i didn't tested vale locally, but i think it was because the upgrade of the vale version and the directory is not reading properly. i can try to run locally.

[PipKat]

i didn't tested vale locally, but i think it was because the upgrade of the vale version and the directory is not reading properly. i can try to run locally.

At least it ran OK in the CI/CD!

[PipKat]

@Revathyvenugopal162 I'll leave this issue with you!
E: The repository 'https://packages.microsoft.com/ubuntu/22.04/prod jammy InRelease' is no longer signed.

[Revathyvenugopal162]

@Revathyvenugopal162 I'll leave this issue with you! E: The repository 'https://packages.microsoft.com/ubuntu/22.04/prod jammy InRelease' is no longer signed.

it was an issue from Microsoft packages and it is fixed by them.

[PipKat]

@Revathyvenugopal162 I edited the contributing.rst file. I also made other edits, especially in regard to where PDF files are saved to (now doc/_build versus where the QMD file is). Also updated the README and landing page to better reflect the content found in each doc section. If you are OK with these changes, feel free to merge and consider the merging my approval for public release.

[Revathyvenugopal162]

Thank you @PipKat For the hard work. merging the PR.