Skip to content

Commit

Permalink
Updates documentation (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
hbcarlos authored Oct 19, 2023
1 parent b4bcd0f commit 0702dc1
Show file tree
Hide file tree
Showing 11 changed files with 704 additions and 244 deletions.
912 changes: 673 additions & 239 deletions docs/RTC_diagrams.drawio

Large diffs are not rendered by default.

16 changes: 11 additions & 5 deletions docs/source/developer/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,25 @@

## Current implementation

COMING...
COMING SOON...

### Class diagram
![classes](../images/class_diagram.png)
![classes](../images/class_diagram.svg)

### Opening a document
![initialization](../images/initialization_diagram.png)
![initialization](../images/initialization_diagram.svg)

### Reconnecting
The websocket connection might close for multiple reasons. In this section you will find a diagram explaining the process of reconnecting
to an old collaborative session.

![reconnect](../images/reconnect_diagram.svg)

### Autosave
![autosave](../images/autosave_diagram.png)
![autosave](../images/autosave_diagram.svg)

### Conflict
![autosave](../images/conflict_diagram.png)
![conflict](../images/conflict_diagram.svg)

## Early attempts

Expand Down
Binary file removed docs/source/images/autosave_diagram.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/source/images/autosave_diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/images/class_diagram.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/source/images/class_diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/images/conflict_diagram.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/source/images/conflict_diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/images/initialization_diagram.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/source/images/initialization_diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/source/images/reconnect_diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0702dc1

Please sign in to comment.