Merge pull request #432 from choldgraf/docs-intro

[DOCS] Adding introductory documentation to the launch buttons

Author: jtpio

docs/_templates/launch.html

@@ -1,7 +1,7 @@
 <strong>Try</strong>
 
 <a
-  href="{{ pathto('_static/lab/index.html', 1) }}"
+  href="{{ pathto('_static/lab/', 1) }}?path=intro.ipynb"
   class="btn btn-warning"
   target="_blank"
   data-toggle="tooltip"
@@ -13,7 +13,7 @@
 </a>
 
 <a
-  href="{{ pathto('_static/retro/index.html', 1) }}"
+  href="{{ pathto('_static/retro/notebooks/index.html', 1) }}?path=intro-retro.ipynb"
   class="btn btn-warning"
   target="_blank"
   data-toggle="tooltip"

examples/README.md

@@ -1,4 +1,11 @@
 # JupyterLite Examples
 
 This folder contains example notebooks and files demoing what is possible to do with
-JupyterLite.
+JupyterLite. To get started, there is a short introduction in
+[the `intro.ipynb` notebook](intro.ipynb).
+
+For examples of using JupyterLite with more kernels, see the other notebooks in this
+folder.
+
+For examples of using JupyterLite for scientific computing, see
+[the `pyolite` examples folder](pyolite).

examples/intro-retro.ipynb

@@ -0,0 +1,44 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "id": "7554b29e-0c66-413f-bda1-8e5ecef46c07",
+      "metadata": {},
+      "source": [
+        "# RetroLab Introduction 🌅\n",
+        "\n",
+        "RetroLab is an alternative JupyterLab distribution, built from the ground-up with JupyterLab components, giving the same look and feel as the Classic Jupyter Notebook interface.\n",
+        "\n",
+        "> **See Also**: For more information about RetroLab, see [the RetroLab documentation](https://github.com/jupyterlab/retrolab#introduction) and [the RetroLab announcement blog post](https://blog.jupyter.org/retrolab-a-jupyterlab-distribution-with-a-retro-look-and-feel-8096b8b223d0).\n",
+        "\n",
+        "RetroLab is focused on a **single document experience**, but re-uses components from the more flexible (but complex) [JupyterLab interface](https://jupyterlab.readthedocs.io). This allows extensions to work between both interfaces, and streamlines the user experience so that they complement one another.\n",
+        "\n",
+        "You can do anything with a Jupyter Notebook that you could do with JupyterLab. For example, see the [intro.ipynb](intro.ipynb) Jupyter Notebook, which is an introduction to this repository's content and contains some pointers to get you started.\n",
+        "\n",
+        "> **Note**: This interface is provided by the [JupyterLite project](https://jupyterlite.readthedocs.io/en/latest/), which embeds an entire JupyterLab interface, with many popular packages for scientific computing, in your browser. There may be some minor differences in behavior between JupyterLite and the JupyterLab you install locally.\n"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Pyolite",
+      "language": "python",
+      "name": "python"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "python",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.8"
+    },
+    "orig_nbformat": 4
+  },
+  "nbformat": 4,
+  "nbformat_minor": 5
+}