More edits to documentation.

Author: JoeZiminski

docs/source/index.md

@@ -36,14 +36,14 @@ Get started with ``datashuttle``
 :link: pages/user_guides/index
 :link-type: doc
 
-Documentation of ``datashuttle``'s features.
+Explore ``datashuttle``'s features
 :::
 
 :::{grid-item-card} Examples
 :link: pages/examples/index
 :link-type: doc
 
-``datashuttle`` in the real world.
+``datashuttle`` in the real world
 :::
 
 :::{grid-item-card} Python API
@@ -55,14 +55,29 @@ Full Python reference
 
 ::::
 
-``datashuttle`` creates and validates projects standardised to the
-[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev)
-specification.
+A lack of project standardization in systems neuroscience
+[hinders data sharing and collaboration](https://neuroinformatics.dev/blog/neuroblueprint.html),
+creating barriers to reproducibility and scientific progress
+
+``datashuttle`` helps creates, validate and transfer projects standardised to the
+[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev) specification:
+
+```{image} /_static/NeuroBlueprint_project_tree_dark.png
+   :align: center
+   :class: only-dark
+   :width: 550px
+```
+```{image} /_static/NeuroBlueprint_project_tree_light.png
+   :align: center
+   :class: only-light
+   :width: 550px
+```
 
 Dive right into ``datashuttle`` with our
 [Getting Started Tutorial](tutorial-getting-started)
 or targeted [How-To Guides](how-tos).  \
 It can be used through a graphical interface or Python API.
+[create-folders.md](pages%2Fuser_guides%2Fcreate-folders.md)
 
 Don't hesitate to get in contact through our
 [GitHub Issues](https://github.com/neuroinformatics-unit/datashuttle/issues)

docs/source/pages/examples/index.md

@@ -13,6 +13,8 @@
 :link-type: doc
 :class-img-top: tutorial-link-image
 
+Using datashuttle to create project folders
+used in a behavioural-data acquisition script.
 
 :::
 
@@ -22,6 +24,7 @@
 :link-type: doc
 :class-img-top: tutorial-link-image
 
+Validating a drive containing a lab's NeuroBlueprint-formatted projects.
 
 :::
 

docs/source/pages/get_started/getting-started.md

@@ -25,7 +25,7 @@ a 'mock' experiment, standardised to the
 We will upload data to a central data storage machine,
 as you would do at the end of a real acquisition session.
 
-Finally we will download data from the central
+Finally, we will download data from the central
 storage to a local machine, as you would do during analysis.
 
 ## Installing ``datashuttle``
@@ -57,7 +57,7 @@ will launch the application in your terminal:
 :::{tab-item} Python API
 :sync: python
 
-We can check ``datashuttle`` has installed correctly by
+We can check ``datashuttle`` has installed correctly
 by importing it into Python without error:
 
 ```python
@@ -67,6 +67,14 @@ from datashuttle import DataShuttle
 :::
 ::::
 
+:::{note}
+
+This walkthrough does not include the recently-added validation
+feature (it will be updated soon). Please see the [validation guide](tutorial-validation)
+for how to validate your project format.
+
+:::
+
 ## Make a new project
 
 The first thing to do when using ``datashuttle`` on a new machine is

docs/source/pages/get_started/quick-validate-project.md

@@ -3,12 +3,12 @@
 # How to Quickly Validate an Existing Project
 
 Datashuttle provides the functionality to validate an existing
-[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) project.
+[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html)-formatted project.
 All NeuroBlueprint issues will be flagged, including a filepath pointing to
 problematic folders.
 
-Below, we explore how to quickly validate a NeuroBlueprint project without
-setting up a full project in ``datashuttle``.
+Below, we explore how to quickly validate a NeuroBlueprint-formatted
+project without setting up a full project in ``datashuttle``.
 
 ::::{tab-set}
 

docs/source/pages/user_guides/index.md

@@ -1,6 +1,6 @@
 :html_theme.sidebar_secondary.remove:
 
-(how-tos)=
+(user-guides)=
 # User Guides
 
 
@@ -13,42 +13,47 @@
 :link-type: doc
 :class-img-top: tutorial-link-image
 
-Check a project for
-[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html)
-formatting issues
+Check a project for [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) formatting issues
 :::
 
 
 :::{grid-item-card} {fas}`desktop;sd-text-primary` Create Folders
 :link: create-folders
 :link-type: doc
+
+Create [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html)-formatted folders
 :::
 
 
 :::{grid-item-card} {fas}`desktop;sd-text-primary` Transfer Data
 :link: transfer-data
 :link-type: doc
 
-Transfer data between a local acquisition
-and central storage machine
+Transfer data between acquisition and storage machines
 :::
 
 
 :::{grid-item-card} {fas}`desktop;sd-text-primary` Update Configs
 :link: update-configs
 :link-type: doc
+
+Change an existing project's configurations
 :::
 
 
 :::{grid-item-card} {fas}`desktop;sd-text-primary` Read Logs
 :link: read-logs
 :link-type: doc
+
+Access full logs of all ``datashuttle``'s actions
 :::
 
 
 :::{grid-item-card} {fas}`desktop;sd-text-primary` Use Name Templates
 :link: use-name-templates
 :link-type: doc
+
+A handy feature for template subject and session names.
 :::
 
 ::::