Restructure README and github pages

[RayStick]

Closes #109

Proposed Changes

• Moved longer tutorial info out of the README and into the 'Getting Started' page on github pages
• Restructured the references on github pages
• Restructured the articles on github pages

Building gh pages locally by running pkgdown::build_site() in R

Things still to do:

• On the 'Getting Started' page (defined here) the plots do not render. Do they need to be in different location? Perhaps docs folder, for gh pages to see them
• Check formatting of all pages on github pages - is the rendering correct?
• Link to getting started page, and articles, in the README
• Consider adding TOC to README, but now it is shorter it might not be needed?

Checklist before review:

• Please comment on my PR while it's a draft and give me feedback on the development!
• I added everything I wanted to add to this PR, please review!
• [if package files were edited] Running devtools::check() returns no errors or warnings.
• The code base and the documentation match (they both reflect any recent changes).
• The title of this PR is clear and self-explantory.
• I added any appropriate labels to this PR.

[BatoolMM]

Thank you so much @RayStick - I would still keep the installation guidelines in the README. Am I correct in assuming that you removed them?

[RayStick]

Good point! What about moving this to the 'Getting Started' github pages? i.e. everything not in the orange box stays in the README

[BatoolMM]

I would still keep at least one brief output for one function - it helps anyone who comes through the packages to get excited about using it. Here is a good RAEDME: https://github.com/allisonhorst/palmerpenguins/

[RayStick]

Ah okay, perhaps I was too hasty in moving things haha.
Shall I just keep the original README? 😅 do you think it is an okay length and format now?
The README renders on the github pages anyways

[BatoolMM]

Yes, pls do keep it for now & I will look again at it on Monday 😊

[RayStick]

Great, thanks, no rush!

[BatoolMM]

Hi @RayStick - I kept it as it is, I think there is a value in showing the plots and outputs in README. I only made minor changes to the format and code.

[RayStick]

Thanks Batool! I will check over the README and the github-pages and mark the PR ready for review after that

[RayStick]

@BatoolMM thanks for all your changes, I like the shorter README

My commits that followed ensured that the 'Getting Started' page and the 'README' page do not overlap in content unnecessarily, and I made sure formatting looked corrected both on the github repo view and the github pages view e.g. all the links work, all the plots render.

Let me know if there are any remaining queries but if not - please approve =D

[BatoolMM]

Please do merge!!!