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

未关闭 适合新手
#168 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
88/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
bootstrap, jupyter-notebook
领域
documentation

调研方向

修改位于 docs/notebooks/index.ipynb,即 JupyterLite 的落地页。打开该 notebook 并检查其最后一个单元格。然后阅读 issue 中的代码片段,它可以直接粘贴为新的 markdown 单元格。完成的标准是:新单元格在 JupyterLite 中于 notebook 末尾正常渲染,div 提示框已应用样式,并且侧边栏中每个链接的文字都正确。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
225
派生
35
平均合并
1 天 12 小时
30 天内合并 PR
33

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

petercorke/machinevision-toolbox-python 的其他 Issue

查看 petercorke/machinevision-toolbox-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。