Merge pull request #866 from NeurodataWithoutBorders/video_tutorial

Add video tutorial to docs and minor improvements
NeurodataWithoutBorders · Jun 17, 2024 · 515b9cf · 515b9cf
2 parents 6fb5bb5 + f6081d1
commit 515b9cf
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -135,6 +135,15 @@
     "doc_path": "docs",
 }
 
+# Workaround for removing the left sidebar on pages without TOC
+# A better solution would be to follow the merge of:
+# https://github.com/pydata/pydata-sphinx-theme/pull/1682
+html_sidebars = {
+    "installation": [],
+    "format_support": [],
+    "developer_guide": [],
+}
+
 
 def _correct_signatures(app, what, name, obj, options, signature, return_annotation):
     if what == "class":

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,12 +10,19 @@ NWB GUIDE documentation
 
 |
 
-The **NWB Graphical User Interface for Data Entry (GUIDE)** is an Electron-based application designed to help you navigate
-the complex process of converting data from common proprietary formats into the :nwb-overview:`Neurodata Without Borders (NWB) <>` standard.
+The **NWB Graphical User Interface for Data Entry (GUIDE)** is a cross-platform desktop application that walks neuroscientists
+through the requirements of converting their data from common proprietary formats to the :nwb-overview:`Neurodata Without Borders (NWB) <>` standard
+and uploading data to the :dandi-archive:`DANDI Archive <>`.
 
-The resulting files are fully compliant with the best practices expected by the :dandi-archive:`Distributed Archives for Neurophysiology Data Integration (DANDI) <>`.
+.. note::
+  Watch a tutorial video of NWB GUIDE `here <https://www.youtube.com/watch?v=EhhdDVuHAZ0>`_.
+
+Get started with NWB GUIDE by :doc:`installing it </installation>` on your computer and following the :doc:`tutorials </tutorials/index>` in this documentation.
+
+.. The TOC below is hidden from the main page contents but needed to generate the top menu
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
 
    installation

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -17,7 +17,7 @@ Download and run `NWB-GUIDE-x64.dmg <https://github.com/NeurodataWithoutBorders/
 MacOS - Apple Silicon
 ---------------------
 
-This installation applies to [current-generation Apple computers (M1-M4+)](https://support.apple.com/en-us/116943).
+This installation applies to `current-generation Apple computers (M1-M4+) <https://support.apple.com/en-us/116943>`_.
 
 Download and run `NWB-GUIDE-arm64.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-arm64.dmg>`_. This will prompt you to move the app into your 'Applications' folder. Then open the 'NWB GUIDE' app from your 'Applications' folder.
 

diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -5,6 +5,9 @@ to the Neurodata Without Borders (NWB) format and uploading to the DANDI Archive
 
 In these tutorials, you'll follow along on a :doc:`local installation of the GUIDE </installation>` as we detail the conversion process from initial setup to final upload.
 
+.. note::
+    Watch a video walkthrough of these tutorials `here <https://www.youtube.com/watch?v=EhhdDVuHAZ0>`_.
+
 .. note::
     This tutorial focuses on uploading to the DANDI Development server.
 
@@ -21,7 +24,10 @@ In these tutorials, you'll follow along on a :doc:`local installation of the GUI
 Before you begin these tutorials, **you'll need to generate the tutorial dataset** using the instructions on the Dataset page.
 
 
+.. toctree::
+   :hidden:
 
+   self
 
 .. toctree::
    :maxdepth: 2