Skip to content

Commit 8fe77a1

Browse files
authored
Add Overview section to README.md (#144)
* Remove outdated content in README. * Added description of project for end users.
1 parent ef6d49a commit 8fe77a1

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,46 @@
1-
# jupyter_server_documents
2-
3-
A JupyterLab extension that provides RTC capabilities.
1+
# Jupyter Server Documents
42

53
This extension is composed of a Python package named `jupyter_server_documents`
64
for the server extension and a NPM package named `@jupyter/server-documents`
75
for the frontend extension.
86

9-
## Try it out
7+
## Overview
108

11-
Run with the proper configuration
9+
Jupyter Server Documents is a powerful extension for JupyterLab that enhances your notebook experience by moving the state of documents to the server. Key features include:
1210

13-
```
14-
jupyter lab --config jupyter_config.py
15-
```
11+
### Real-Time Collaboration
12+
13+
- New, optimized real-time collabortion engine for Jupyter Server
14+
- Significant performance and memory usage improvements
15+
- Proper handling of out-of-band changes (e.g. `git checkout`)
16+
- No data loss or duplication
17+
18+
### Enhanced Performance
19+
20+
- Optimized memory usage through intelligent output management
21+
- Significantly faster loading of notebooks with large outputs
22+
- Reduced memory footprint for notebooks with extensive output data
23+
- Automatic saving of changes to prevent data loss
24+
25+
### Improved Kernel Management
26+
27+
- More reliable kernel execution and connection handling
28+
- Enhanced stability with better error recovery mechanisms
29+
- Streamlined message handling between kernels and the frontend
30+
- Improved kernel restart and reconnection capabilities
31+
32+
### Efficient Output Handling
33+
34+
- Smart output storage separates large outputs from notebook documents
35+
- Output streaming controls prevent memory issues with unbounded outputs
36+
- Faster notebook navigation even with extensive computational outputs
37+
- Lazy loading of outputs for improved responsiveness
38+
39+
This extension provides the foundation for a more collaborative, stable, and performant JupyterLab experience, especially valuable for data scientists and researchers working with complex notebooks or in team environments.
1640

1741
## Requirements
1842

19-
- JupyterLab >= 4.0.0
43+
- JupyterLab >= 4.4.0
2044

2145
## Installation
2246

0 commit comments

Comments
 (0)