Adds documentation

jupyterlab · Oct 12, 2023 · db6fe93 · db6fe93
1 parent 8183da4
commit db6fe93
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 2 deletions.
diff --git a/docs/source/configuration.md b/docs/source/configuration.md
@@ -26,6 +26,6 @@ jupyter lab --YDocExtension.file_poll_interval=2
 # If None, the document will be kept in memory forever.
 jupyter lab --YDocExtension.document_cleanup_delay=100
 
-# The YStore class to use for storing Y updates (default: JupyterSQLiteYStore).
-jupyter lab --YDocExtension.ystore_class=ypy_websocket.ystore.TempFileYStore
+# The Store class used for storing Y updates (default: SQLiteYStore).
+jupyter lab --YDocExtension.ystore_class=jupyter_collaboration.stores.FileYStore
 ```
diff --git a/docs/source/developer/architecture.md b/docs/source/developer/architecture.md
@@ -4,6 +4,15 @@
 
 COMING...
 
+### Opening a document
+![initialization](../images/initialization_diagram.png)
+
+### Autosave
+![autosave](../images/autosave_diagram.png)
+
+### Conflict
+![autosave](../images/conflict_diagram.png)
+
 ## Early attempts
 
 Prior to the current implementation based on [Yjs](https://docs.yjs.dev/), other attempts using

diff --git a/docs/source/images/autosave_diagram.png b/docs/source/images/autosave_diagram.png
diff --git a/docs/source/images/conflict_diagram.png b/docs/source/images/conflict_diagram.png
diff --git a/docs/source/images/initialization_diagram.png b/docs/source/images/initialization_diagram.png