Rename index.md to README.md

[SooluThomas]

Renaming index.md file in docs to README.md. Also I think the best place for this is the README file in the root directory. Comments or suggestions appreciated.

[JuLieAlgebra]

Oh sorry, the index.md is for mkdocs! I believe it needs to all be within the docs folder and index is the typical name for the landing page of your mkdocs project documentation, can definitely call it anything else though. (There is a README in the project root already)

[SooluThomas]

Oh, okay. Then I think, we should move all sections after the "Documentation" section to readme so that everyone knows how to serve the docs. What do you think

[JuLieAlgebra]

@SooluThomas That's a good idea! Requiring you to build the docs in order to nicely see the instructions on how to build the docs is some circular logic, haha.

If the making-the-repo-public and docs-deployment goes smoothly tomorrow, I'll update the README.md link to the hosted site for Setup instructions (instead of the local link to the unrendered markdown file), then will add the instructions for building the docs locally to the README if that sounds reasonable to you.

[JuLieAlgebra]

@SooluThomas Okie doke, pushed some changes! Let me know what you think.

I updated the REAMDE link to the Setup pages on the hosted site, moved instructions for building the docs locally to setup.md (since the intended experience is for people to view the documentation online and build docs locally if they're making changes to them and want to test that out before merging?), and modified the mac OS pixi installation instructions based on test setup run with Matt.

Totally fine to add the local-doc-building instructions to the README if you prefer that over the changes I made; give a shout either way :)

[SooluThomas]

This looks great. Thank you so much for updating them. We can merge #5 whenever you approve it and then merge this after ❤️

[JuLieAlgebra]

This looks great. Thank you so much for updating them. We can merge #5 whenever you approve it and then merge this after ❤️

Thanks Soolu! That sounds like a plan :)