WebApp: Added documention

joplin · Jul 22, 2021 · 69c8200 · 69c8200
1 parent fb1506d
commit 69c8200
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 0 deletions.
diff --git a/app-collab-note/src/containers/CollabNote/index.tsx b/app-collab-note/src/containers/CollabNote/index.tsx
@@ -50,6 +50,7 @@ const ViewContainer = styled.div`
 
     :last-child {
       border-right: none;
+      padding-right: 10px;
     }
   }
 `;

diff --git a/readme/web-app/collaborative-editor.md b/readme/web-app/collaborative-editor.md
@@ -0,0 +1,25 @@
+# Collaborative Editor
+
+## Toolbar Options
+
+Currently, there are 3 options available
+
+![](images/toolbar-options.gif)
+
+### Fetch Note
+
+The fetch option is available only for the host to fetch the note from the Joplin Desktop app. This is useful if there are any changes made to the note through the Joplin Desktop app as demonstrated below
+
+![](images/fetch-option-demo.gif)
+
+### Save Note
+
+Save option is also a host-specific option used to save the changes made through the Collaborative editor back to Joplin Desktop.
+
+![](images/save-option-demo.gif)
+
+### Copy Room ID
+
+To invite other users to collaborate on the note you can copy the room ID and share it with them. Using which they can join the collaborative session.
+
+![](images/share-room-id-demo.gif)
diff --git a/readme/web-app/images/fetch-option-demo.gif b/readme/web-app/images/fetch-option-demo.gif
diff --git a/readme/web-app/images/save-option-demo.gif b/readme/web-app/images/save-option-demo.gif
diff --git a/readme/web-app/images/share-room-id-demo.gif b/readme/web-app/images/share-room-id-demo.gif
diff --git a/readme/web-app/images/toolbar-options.gif b/readme/web-app/images/toolbar-options.gif
-Original file line number
+Diff line change
@@ Expand Up / @@ -50,6 +50,7 @@ const ViewContainer = styled.div` @@
         :last-child {
           border-right: none;
+          padding-right: 10px;
         }
       }
     `;
@@ Expand Down @@