Skip to content

Commit 7199d7e

Browse files
committed
feat: update documentation with structured quick start and advanced showcase links
1 parent 2ae1494 commit 7199d7e

File tree

3 files changed

+44
-23
lines changed

3 files changed

+44
-23
lines changed

.nblink/nblink-lock.json

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
{
22
"id": "1223418422504585",
3+
"lockVersion": "1.0.3",
34
"specs": [
45
"xeus-python",
56
"datalab-kernel",
7+
"plotly",
68
"micropip"
79
],
810
"channels": [
@@ -957,6 +959,18 @@
957959
"subdir": "emscripten-wasm32",
958960
"channel": "emscripten-forge",
959961
"version": "3.10.8"
962+
},
963+
"plotly-6.5.2-pyhd8ed1ab_0.conda": {
964+
"hash": {
965+
"md5": "7702bcd70891dd0154d765a69e1afa94",
966+
"sha256": "48d2caf66b8209bfb3fa160f5bc7cbd625deaa4826e8aa1bad706b2dd22bbb86"
967+
},
968+
"name": "plotly",
969+
"size": 4924275,
970+
"build": "pyhd8ed1ab_0",
971+
"subdir": "noarch",
972+
"channel": "conda-forge",
973+
"version": "6.5.2"
960974
}
961975
},
962976
"platform": "emscripten-wasm32",
@@ -982,6 +996,5 @@
982996
}
983997
]
984998
},
985-
"lockVersion": "1.0.2",
986999
"pipPackages": {}
9871000
}

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![pypi version](https://img.shields.io/pypi/v/datalab-kernel.svg)](https://pypi.org/project/datalab-kernel/)
55
[![PyPI status](https://img.shields.io/pypi/status/datalab-kernel.svg)](https://github.com/DataLab-Platform/DataLab-Kernel)
66
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/datalab-kernel.svg)](https://pypi.org/project/datalab-kernel/)
7-
[![DataLab-Kernel Quick Start](https://img.shields.io/badge/notebook-link-e2d610?logo=jupyter&logoColor=white)](https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=/notebooks/datalab_kernel_quickstart.ipynb)
7+
[![Quick Start](https://img.shields.io/badge/Quick_Start-notebook.link-e2d610?logo=jupyter&logoColor=white)](https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=/notebooks/datalab_kernel_quickstart.ipynb)
8+
[![Advanced Showcase](https://img.shields.io/badge/Advanced_Showcase-notebook.link-e2d610?logo=jupyter&logoColor=white)](https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=%2Fnotebooks%2Fdatalab_kernel_advanced.ipynb)
89

910
**A standalone [Xeus-Python](https://github.com/jupyter-xeus/xeus-python)-based Jupyter kernel providing seamless, reproducible access to DataLab workspaces, with optional live synchronization to the DataLab GUI.**
1011

@@ -36,16 +37,12 @@ It is a **complementary execution layer** that turns DataLab into a hybrid scien
3637

3738
**Experience DataLab-Kernel instantly in your browser** — no installation required!
3839

39-
[![DataLab-Kernel Quick Start](https://img.shields.io/badge/notebook-link-e2d610?logo=jupyter&logoColor=white)](https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=/notebooks/datalab_kernel_quickstart.ipynb)
40+
| Notebook | Description | Link |
41+
| --- | --- | --- |
42+
| **Quick Start** | Introduction to Workspace, Plotter, and basic Sigima processing | [![Quick Start](https://img.shields.io/badge/Quick_Start-notebook.link-e2d610?logo=jupyter&logoColor=white)](https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=/notebooks/datalab_kernel_quickstart.ipynb) |
43+
| **Advanced Showcase** | Advanced plotting, signal/image processing, ROI, and analysis | [![Advanced Showcase](https://img.shields.io/badge/Advanced_Showcase-notebook.link-e2d610?logo=jupyter&logoColor=white)](https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=%2Fnotebooks%2Fdatalab_kernel_advanced.ipynb) |
4044

41-
Click the badge above to open the quickstart notebook in a live JupyterLite environment powered by [**notebook.link**](https://notebook.link/). This service, developed by [**QuantStack**](https://quantstack.net/), enables sharing and running Jupyter notebooks directly in the browser with zero setup.
42-
43-
Simply run the cells to explore:
44-
45-
- Loading the DataLab-Kernel extension
46-
- Accessing workspace objects
47-
- Visualizing images inline
48-
- Processing data with Sigima
45+
Click a badge to open the notebook in a live JupyterLite environment powered by [**notebook.link**](https://notebook.link/). This service, developed by [**QuantStack**](https://quantstack.net/), enables sharing and running Jupyter notebooks directly in the browser with zero setup.
4946

5047
---
5148

doc/index.rst

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,21 +86,32 @@ Try it Online
8686

8787
**Experience DataLab-Kernel instantly in your browser** — no installation required!
8888

89-
.. image:: https://img.shields.io/badge/notebook-link-e2d610?logo=jupyter&logoColor=white
89+
.. list-table::
90+
:header-rows: 1
91+
:widths: 20 50 30
92+
93+
* - Notebook
94+
- Description
95+
- Link
96+
* - **Quick Start**
97+
- Introduction to Workspace, Plotter, and basic Sigima processing
98+
- |badge_quickstart|
99+
* - **Advanced Showcase**
100+
- Advanced plotting, signal/image processing, ROI, and analysis
101+
- |badge_advanced|
102+
103+
.. |badge_quickstart| image:: https://img.shields.io/badge/Quick_Start-notebook.link-e2d610?logo=jupyter&logoColor=white
90104
:target: https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=/notebooks/datalab_kernel_quickstart.ipynb
91-
:alt: Try it online
105+
:alt: Quick Start notebook
92106

93-
Click the badge above to open the quickstart notebook in a live JupyterLite
94-
environment powered by `notebook.link <https://notebook.link/>`_. This service,
95-
developed by `QuantStack <https://quantstack.net/>`_, enables sharing and running
96-
Jupyter notebooks directly in the browser with zero setup.
107+
.. |badge_advanced| image:: https://img.shields.io/badge/Advanced_Showcase-notebook.link-e2d610?logo=jupyter&logoColor=white
108+
:target: https://notebook.link/github/DataLab-Platform/DataLab-Kernel/tree/main/notebooks/?path=%2Fnotebooks%2Fdatalab_kernel_advanced.ipynb
109+
:alt: Advanced Showcase notebook
97110

98-
Simply run the cells to explore:
99-
100-
- Loading the DataLab-Kernel extension
101-
- Accessing workspace objects
102-
- Visualizing images inline
103-
- Processing data with Sigima
111+
Click a badge to open the notebook in a live JupyterLite environment powered by
112+
`notebook.link <https://notebook.link/>`_. This service, developed by
113+
`QuantStack <https://quantstack.net/>`_, enables sharing and running Jupyter
114+
notebooks directly in the browser with zero setup.
104115

105116

106117
**Unified API**

0 commit comments

Comments
 (0)