JupyterLab RTC Documentation

Real Time Collaboration for Jupyter and beyond

JupyterLab RTC is the realtime collaboration foundation for Project Jupyter and follows the Jupyter Community Guides.

Think to a Google Docs or HackMD for Jupyter.

Note

The JupyterLab RTC project is still in the inception stage and is rapidly evolving in terms of design and implementation. Use at your own risk. If you find any issues or have requirements, please report them on the Issue Board.

We welcome you to contribute to this project.

Site Contents

About RTC

• User Stories
  • Shared Kernel
  • Remote Resources
  • Permissions
  • Chat
• Algorithms
  • CRDT
  • OT
  • Diffs
  • Mixed
  • Others
• Implementations
• Persistence
  • Distributed Databases
  • Distributed Storage
  • File Synchronisation

Developer Guide

• Design
  • Goals
  • Non Goals
• Specifications
  • Specification Details
  • Cross-cutting Concerns
• Architecture
  • Packages
  • Other Potential Packages
  • Actors
  • Use Cases
• Examples
  • Lumino Example
  • To Do Example
  • Jupyter Example
• Integrations
  • JupyterLab
• Benchmark
• Visualization
  • OT
  • CRDT
• GitHub repo

Project Organisation

• Deliverables
• Contribute
• CZI Grant 2020
  • Abstract
  • Work Plan
  • Milestones and Deliverables