From 3cb5a3319ee4b3245d675e83cd0d0f1b0d52d708 Mon Sep 17 00:00:00 2001
From: ehennestad <ehennestad@gmail.com>
Date: Fri, 6 Dec 2024 21:48:12 +0100
Subject: [PATCH] Update main page and add installation instructions

---
 docs/source/conf.py                      | 16 ++++++++++++++++
 docs/source/index.rst                    | 20 ++++++++++++++------
 docs/source/pages/install_users.rst      |  4 ----
 docs/source/pages/installation_users.rst | 21 +++++++++++++++++++++
 4 files changed, 51 insertions(+), 10 deletions(-)
 delete mode 100644 docs/source/pages/install_users.rst
 create mode 100644 docs/source/pages/installation_users.rst

diff --git a/docs/source/conf.py b/docs/source/conf.py
index b14ade56..b5da8423 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -30,6 +30,7 @@ def setup(app):
     'sphinx.ext.autodoc', # autogenerate docs
     'sphinx.ext.napoleon', # for parsing e.g google style parameter docstring
     'sphinx.ext.viewcode',
+    'sphinx.ext.extlinks', # For maintaining external links
     'sphinx_copybutton',
 ]
 
@@ -67,3 +68,18 @@ def setup(app):
 html_css_files = [
     'css/custom.css',
 ]
+
+
+# External links used in the documentation 
+extlinks = {
+    'incf_lesson': ('https://training.incf.org/lesson/%s', '%s'),
+    'incf_collection': ('https://training.incf.org/collection/%s', '%s'),
+    'nwb_extension': ('https://github.com/nwb-extensions/%s', '%s'),
+    'pynwb': ('https://github.com/NeurodataWithoutBorders/pynwb/%s', '%s'),
+    'nwb_overview': ('https://nwb-overview.readthedocs.io/en/latest/%s', '%s'),
+    'hdmf-docs': ('https://hdmf.readthedocs.io/en/stable/%s', '%s'),
+    'dandi': ('https://www.dandiarchive.org/%s', '%s'),
+    "nwbinspector": ("https://nwbinspector.readthedocs.io/en/dev/%s", "%s"),
+    'hdmf-zarr': ('https://hdmf-zarr.readthedocs.io/en/latest/%s', '%s'),
+    'matlab-online-tutorial': ('https://matlab.mathworks.com/open/github/v1?repo=NeurodataWithoutBorders/matnwb&file=tutorials/%s.mlx', '%s')
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 327d56ad..822f21a6 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,15 +1,23 @@
-MatNWB documentation
-====================
+##############
+NWB for MATLAB
+##############
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
+MatNWB is a MATLAB package for working with NWB files. It provides a high-level 
+API for efficiently working with neurodata stored in the NWB format. If you are 
+new to NWB and would like to learn more, then please also visit the 
+:nwb_overview:`NWB Overview <>` website, which provides an entry point for 
+researchers and developers interested in using NWB.
+
+
+********
+Contents
+********
 
 .. toctree::
    :maxdepth: 2
    :caption: Getting Started
 
-   pages/install_users
+   pages/installation_users
    pages/tutorials/index
    pages/overview_citing
 
diff --git a/docs/source/pages/install_users.rst b/docs/source/pages/install_users.rst
deleted file mode 100644
index 20156dbf..00000000
--- a/docs/source/pages/install_users.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Install MatNWB
-==============
-
-Todo: installation
\ No newline at end of file
diff --git a/docs/source/pages/installation_users.rst b/docs/source/pages/installation_users.rst
new file mode 100644
index 00000000..25a5dd99
--- /dev/null
+++ b/docs/source/pages/installation_users.rst
@@ -0,0 +1,21 @@
+Install MatNWB
+==============
+
+Download the current release of MatNWB from the 
+`MatNWB releases page <https://github.com/NeurodataWithoutBorders/matnwb/releases>`_ 
+or from the `MATLAB's FileExchange <https://www.mathworks.com/matlabcentral/fileexchange/67741-neurodatawithoutborders-matnwb>`_. 
+You can also check out the latest development version via::
+
+    git clone https://github.com/NeurodataWithoutBorders/matnwb.git
+
+After downloading MatNWB, make sure to add it to MATLAB's search path:
+
+.. code-block:: matlab
+
+    addpath("path/to/matnwb")
+    savepath() % Permanently add to search path
+
+Requirements
+------------
+
+MATLAB R2016 or later?