diagrams

Tony-xy-Liu · Oct 5, 2021 · 1a6428b · 1a6428b
1 parent 6af35f7
commit 1a6428b
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 5 deletions.
diff --git a/docs/source/connections.rst b/docs/source/connections.rst
@@ -8,7 +8,7 @@ On the Network
 ELab
 ----
 
-A wrapper inheriting ``Connection`` was created to provide typing for
+A wrapper inheriting ``Connections`` was created to provide typing for
 `eLab's API <https://www.elabjournal.com/docs/api/index>`_ and integrate it as a
 ``Provider``.
 
@@ -18,12 +18,12 @@ Server
 ------
 
 The server runs on a VM where access is only possible via SSH. It impliments the
-``Provider`` interface (specified by the ``Connection`` module) with additional
+``Provider`` interface (specified by the ``Connections`` module) with additional
 endpoints for the :ref:`portal<port-title>` and printers. This is meant to be the
 persistent source of truth for the network, though communications with other network
 elements need not always go through the server.
 
-The server supports both ``REST`` and ``SocketIO`` protocols.
+The server utilizes both ``REST`` and ``SocketIO`` protocols.
 
 .. _con-shamwow:
 

diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -1,7 +1,44 @@
 .. _contr-title:
 
+.. _contr-top:
+
 Contributing
 ============
 
 More details coming soon. In the meantime, 
-take a peek at the `repo on Git <https://github.com/Tony-xy-Liu/Limes>`_.
+take a peek at the `repo on Git <https://github.com/Tony-xy-Liu/Limes>`_.
+
+Architecture Diagrams
+---------------------
+
+.. _contr-models:
+
+Models
+"""""""""
+
+.. _contr_con:
+
+.. image:: res/Arch-models.svg
+
+Connections
+"""""""""""""
+
+.. _contr_core:
+
+.. image:: res/Arch-con.svg
+
+Core Server
+"""""""""""""
+
+.. image:: res/Arch-core.svg
+
+.. _contr_providers:
+
+Providers
+"""""""""
+
+.. image:: res/Arch-provider.svg
+
+---------------------------------------------------------------------------
+
+:ref:`Back to top<contr-top>`
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -73,7 +73,7 @@ d. `Example Staging Areas <https://elab.msl.ubc.ca/members/inventory/browser/?in
 
 ------------------------------------
 
-Linking Sequencing Data to the Original Samples
+Linking Sequencing Data to Physical Samples
 -----------------------------------------------
 
 *Coming soon*

diff --git a/docs/source/res/Arch-client.svg b/docs/source/res/Arch-client.svg
diff --git a/docs/source/res/Arch-con.svg b/docs/source/res/Arch-con.svg
diff --git a/docs/source/res/Arch-core.svg b/docs/source/res/Arch-core.svg