diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 932f34516..65327b05d 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -36,7 +36,4 @@ tags: 3. Title should be the tag name (Exp: v0.6.1) 4. Add the release notes from the changelog.md for the specific version in the description 5. New contributors should be mentioned additionally -5. Upload the files from the `upload-for-github-release` folder - -## Architecture -![Architecture Diagram](./architecture-diagram.svg) +5. Upload the files from the `upload-for-github-release` folders diff --git a/architecture-diagram.md b/docs/architecture-diagram.md similarity index 53% rename from architecture-diagram.md rename to docs/architecture-diagram.md index 70591383d..fd96d62ad 100644 --- a/architecture-diagram.md +++ b/docs/architecture-diagram.md @@ -1,3 +1,7 @@ +# Alva Data Flow +A diagram describing the technical data flow from the Alva application. + + ```mermaid graph BT subgraph MainProcess @@ -17,7 +21,6 @@ graph BT end mainContext-. Updates .-ws - end subgraph BrowserWindow @@ -32,5 +35,19 @@ graph BT http-- Initial Html -->previewContext ws-. Updates .-previewContext end + end + + style webpack fill:#F4743B,stroke:#545454,stroke-width:2px + style ts fill:#F4743B,stroke:#545454,stroke-width:2px + + style http fill:#F1F7ED,stroke:#545454,stroke-width:2px + style ws fill:#F1F7ED,stroke:#545454,stroke-width:2px + + style mainContext fill:#17BEBB,stroke:#545454,stroke-width:2px + style clientContext fill:#17BEBB,stroke:#545454,stroke-width:2px + style previewContext fill:#17BEBB,stroke:#545454,stroke-width:2px + linkStyle 4 stroke:#DDBEC8,stroke-width:2px,stroke-dasharray: 5, 5 + linkStyle 6 stroke:#DDBEC8,stroke-width:2px,stroke-dasharray: 5, 5 + ``` diff --git a/docs/architecture-diagram.svg b/docs/architecture-diagram.svg deleted file mode 100644 index d90e1ea75..000000000 --- a/docs/architecture-diagram.svg +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -