Add introductory slides to docs (#394)

* Move slides into docs directory

* Link to slides

Author: tomwhite

docs/conf.py

@@ -119,4 +119,4 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 # html_static_path = ["_static"]
 
-html_extra_path = ["../examples/cubed.slides.html"]
+html_extra_path = ["slides/intro/cubed-intro.slides.html"]

docs/getting-started/index.md

@@ -2,6 +2,8 @@
 
 This guide aims to get you started using Cubed as quickly as possible.
 
+Have a look at [Cubed: an introduction](https://cubed-dev.github.io/cubed/cubed-intro.slides.html) for a high-level overview.
+
 ```{toctree}
 ---
 maxdepth: 2

docs/index.md

@@ -20,6 +20,7 @@ caption: For users
 ---
 getting-started/index
 user-guide/index
+Intro slides <https://cubed-dev.github.io/cubed/cubed-intro.slides.html>
 Examples <https://github.com/tomwhite/cubed/tree/main/examples/README.md>
 api
 array-api

examples/cubed-idea.svg renamed to docs/slides/intro/cubed-idea.svg

@@ -161,7 +161,7 @@
     "\n",
     "Cubed is composed of five layers: from the storage layer at the bottom, to the Array API layer at the top: \n",
     "\n",
-    "![Five layer diagram](../docs/images/design.svg)"
+    "![Five layer diagram](../../images/design.svg)"
    ]
   },
   {
@@ -175,7 +175,7 @@
    "source": [
     "# Core and Primitive Operations\n",
     "\n",
-    "![Core and Primitive Operations](../docs/images/ops.dot.svg)"
+    "![Core and Primitive Operations](../../images/ops.dot.svg)"
    ]
   },
   {
@@ -189,7 +189,7 @@
    "source": [
     "# Example: `map_direct`\n",
     "\n",
-    "![`map_direct`](../docs/images/map_direct.svg)\n",
+    "![`map_direct`](../../images/map_direct.svg)\n",
     "\n",
     "Each block in the output array is read directly from one or more blocks from the inputs.\n",
     "\n",
@@ -207,7 +207,7 @@
    "source": [
     "# Example: `reduction`\n",
     "\n",
-    "![`reduction`](../docs/images/reduction.svg)\n",
+    "![`reduction`](../../images/reduction.svg)\n",
     "\n",
     "Implemented using multiple rounds of calls to `blockwise` and `rechunk`."
    ]
@@ -369,7 +369,7 @@
     "\n",
     "Cubed models the memory used by every operation, and calculates the `projected_mem` for a task - an upper bound.\n",
     "\n",
-    "<img src=\"../docs/images/memory.svg\" width=\"600\">"
+    "<img src=\"../../images/memory.svg\" width=\"600\">"
    ]
   },
   {
@@ -562,14 +562,6 @@
     "    * sgkit\n",
     "* [Optimizations](https://github.com/tomwhite/cubed/issues?q=is%3Aissue+is%3Aopen+label%3Aoptimization)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0979b928",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -589,7 +581,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.9.18"
   }
  },
  "nbformat": 4,