Refactor documentation

[JoeZiminski]

This PR reworks the documentation to be more accessible for first-time users. The main changes are:

• Better split the documentation into 'Getting Started' and more detailed 'User Guides' section. Now Getting Started contains all guides to quickly get set up, and does not require setting up transfer-related configs to get started (e.g. if only validating or creating folders)
• Add some detail as to the purpose of datashuttle to the front page
• Add two example scripts for how datashuttle is used in the real world
• In general tidy up and update the documentation

For review, don't think reviewing the diff would be that useful as there are a lot of formatting changes. However it would be great to get feedback on how accessible the docs layout etc. seem for new users. The actual content of the documentation has not changed (except for the 'Set up a project' page).

[sumana-2705]

Hello @JoeZiminski, I have added a few comments based on my observations regarding the user experience. Please have a look, and feel free to ignore anything that may not be necessary. Thank you!

[cs7-shrey]

Hey @JoeZiminski I think this PR also contains the contents of #492.
I'm not sure if that was intended.
I think you did a git checkout on add_validation_to_tui branch

[JoeZiminski]

Thanks Both! Ah yes I did branch off as you mention @cs7-shrey, once #492 is merged I will rebase this back on main and drop those commits!

[adamltyson]

I think here we should suggest a way for users to get Python if needed, maybe like we do in BrainGlobe.

[JoeZiminski]

I added a link to Real Python's installation guide, there is a guide to conda installation in the 'Conda' box if this seems enough:

[adamltyson]

To simplify things for the user (and us when when supporting), should we only recommend a conda-based installation? Users can of course use their own installation if they know what they're doing.

[JoeZiminski]

Do you mean from the new link (i.e. recommend using conda to install python (see this guide for how...) or to remove the Pip tab from the installation instructions? I agree for the former, for the later I think it can be useful to have the Pip tab there just in case there are new users who have had trouble with conda installations (generally on Windows).

[adamltyson]

Sorry, yes I meant a conda installation of Python

[JoeZiminski]

Great will make that change

[JoeZiminski]

Cheers @adamltyson! Let me know what you think of the suggested changes

[JoeZiminski]

Hey @adamltyson thanks for the review I think the docs are much clearer for new users now, let me know if any further changes are needed

[adamltyson]

Yep, looks good. I think this PR is good to merge, we can look to tweak bits here and there as we go rather than trying to make everything perfect in this PR.