Closed cchwala closed 1 year ago
index notebook is now shown as the starting page, see #34
We still have to polish things (README and index notebook) a bit more.
The index notebook has been iterated and improved. The README sees gradual improvements, too. I close this issue in favor of specific issues, e.g. #61 and #63 .
Summary
We have to make the navigation of the (growing) interactive content of the sandbox easier, in particular for users that are not experienced with github repos and/or jupyter notebooks.
There are two main things that we should improve:
Potential improvements of the README
Potential index notebook for navigation in binder
As shown in the ipython-in-depth repo one can use a "index.ipynb" (note that here, they have a separate notebook in the subdir
binder
) that will be launched when a binder instance is created. The notebook that is displayed after startup can be configured with something likehttps://mybinder.org/....?filepath=binder/Index.ipynb
in the URL behind the binder launch button.The links in the markdown part of this notebook are relative links to other notebooks in the same repo. As far as I can see these links are automatically resolved so that they launch the linked notebook when running the repo on binder.
E.g. the following markdown code
is behind the first cell of the notebook which looks like this
The link to the first notebook, when running on binder, is
⚠️ ⚠️ ⚠️ Important note: I am not sure if this approach also works when running jupyterlab in binder. The shown example is using jupyter-notebooks, which works when opening a new browser tab after clicking a link. With jupyterlab this might not work because it is meant to run completely within one browser tab, having its own tabs for different notebooks. ⚠️ ⚠️ ⚠️