Skip to content

Commit

Permalink
Remove mention to y_py in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
martinRenou committed Feb 8, 2024
1 parent 48274ea commit e4e5c23
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

The `jupyter_ydoc` repository includes various models that JupyterLab uses for collaborative editing. These models use a specific implementation of a CRDT, the Y-CRDTs. To be more precise, the JavaScript package uses [yjs](https://github.com/yjs/yjs), while the Python package uses [y_py](https://github.com/y-crdt/ypy).
The `jupyter_ydoc` repository includes various models that JupyterLab uses for collaborative editing. These models use a specific implementation of a CRDT, the Y-CRDTs. To be more precise, the JavaScript package uses [yjs](https://github.com/yjs/yjs), while the Python package uses [pycrdt](https://github.com/jupyter-server/pycrdt).

Jupyter YDoc was designed to centralize the data structures used for composing a document in a single class, hide the complicated edge cases of CRDTs, and prevent users from inserting invalid data or adding new attributes to the document that are not part of the schema.

Expand All @@ -19,7 +19,7 @@ Built on top of [yjs](https://github.com/yjs/yjs), `@jupyter/ydoc` is a JavaScri


## `jupyter-ydoc`
Built on top of [y_py](https://github.com/y-crdt/ypy), `jupyter-ydoc` is a Python package that includes the models used in the JupyterLab back-end for representing collaborative documents.
Built on top of [pycrdt](https://github.com/jupyter-server/pycrdt), `jupyter-ydoc` is a Python package that includes the models used in the JupyterLab back-end for representing collaborative documents.

**Source Code:** [GitHub](https://github.com/jupyter-server/jupyter_ydoc/tree/main/jupyter_ydoc)

Expand Down

0 comments on commit e4e5c23

Please sign in to comment.