Skip to content

The JupyterLite index page does not explain the sidebar or that its files are volatile #168

Open

Description

@petercorke

Likely smell, found while working on the notebooks in RTB. Worth checking out and adding.

docs/notebooks/index.ipynb is the landing page of the JupyterLite site, but it says nothing about the sidebar. A new user does not learn that the files listed there live only in the browser (IndexedDB), how to upload or open one, or that clearing the browser cache or ending the session loses them. RTB now has a short section for this (petercorke/robotics-toolbox-python#917), as a Bootstrap alert box, which JupyterLab and JupyterLite style with theme colors:

## Working with files

<div class="alert alert-info">

**The sidebar.** The left-hand **sidebar** lists the local files, which are kept in a virtual file system within the browser (managed via IndexedDB).

* To create a new notebook use *File/New/Notebook*
* To upload a notebook or data file use the upload icon above the sidebar, or drag and drop files onto the sidebar
* To load and open a file from a URL, use *File/Open From URL...*

These files are volatile and vulnerable to browser cache clearing or session termination. You can download these files to your local drive by right-clicking a file in the sidebar and selecting *Download*.

</div>

It goes as a new last cell of index.ipynb.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions