From d51cb07087388bee6e9d754b4f4dc780c4b10d38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Bj=C3=A4reholt?= Date: Wed, 10 Jul 2024 10:55:55 +0200 Subject: [PATCH 1/2] docs: added WIP mermaid architecture diagram --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92ec3ff1..a2c45264 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@

- @@ -33,7 +32,6 @@

- @@ -181,6 +179,28 @@ We have a plan to address all of these and we're well on our way. See the table For a complete list of the things ActivityWatch can track, [see the page on *watchers* in the documentation](https://docs.activitywatch.net/en/latest/watchers.html). +## Architectore + +```mermaid +graph TD; + W[Watchers] -- Capture and send events --> S[Server]; + S --> aw-sync --> SF[Sync folder]; + SF --> aw-sync --> S; + UI[Web UI] -- Fetches data --> S; + +classDef lightMode fill:#FFFFFF, stroke:#333333, color:#333333; +classDef darkMode fill:#333333, stroke:#FFFFFF, color:#FFFFFF; + +classDef lightModeLinks stroke:#333333; +classDef darkModeLinks stroke:#FFFFFF; + +class A,B,C,D,E,G lightMode; +class A,B,C,D,E,G darkMode; + +linkStyle 0 stroke:#FF4136, stroke-width:2px; +linkStyle 1 stroke:#1ABC9C, stroke-width:2px; +``` + ## About this repository This repo is a bundle of the core components and official modules of ActivityWatch (managed with `git submodule`). Its primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation. It is also where releases of the full suite are published (see [releases](https://github.com/ActivityWatch/activitywatch/releases)). From 9e650223be867d10122304eb2d413d29c35c827c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Bj=C3=A4reholt?= Date: Wed, 10 Jul 2024 11:28:10 +0200 Subject: [PATCH 2/2] docs: improvements to WIP mermaid diagram --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a2c45264..618ba8cc 100644 --- a/README.md +++ b/README.md @@ -179,14 +179,22 @@ We have a plan to address all of these and we're well on our way. See the table For a complete list of the things ActivityWatch can track, [see the page on *watchers* in the documentation](https://docs.activitywatch.net/en/latest/watchers.html). -## Architectore +## Architecture ```mermaid graph TD; - W[Watchers] -- Capture and send events --> S[Server]; - S --> aw-sync --> SF[Sync folder]; - SF --> aw-sync --> S; - UI[Web UI] -- Fetches data --> S; + aw-qt -- Manages --> S; + aw-qt -- Manages --> aw-notify -- Queries --> S; + aw-qt -- Manages --> W1[aw-watcher-window] -- Watches --> S1[Active window] -- Heartbeats --> S[aw-server]; + aw-qt -- Manages --> W2[aw-watcher-afk] -- Watches --> S2[AFK status] -- Heartbeats --> S[aw-server]; + Browser -- Manages --> aw-watcher-web -- Watches --> S3[Active tab] -- Heartbeats --> S; + SF -- Dropbox/Syncthing/etc --> SF; + S <-- aw-sync --> SF[Sync folder]; + S -- Serves --> UI[aw-webui]; + + %% User -- Interacts --> UI; + %% User -- Observes --> aw-notify; + %% User -- Interacts --> aw-qt; classDef lightMode fill:#FFFFFF, stroke:#333333, color:#333333; classDef darkMode fill:#333333, stroke:#FFFFFF, color:#FFFFFF; @@ -197,8 +205,8 @@ classDef darkModeLinks stroke:#FFFFFF; class A,B,C,D,E,G lightMode; class A,B,C,D,E,G darkMode; -linkStyle 0 stroke:#FF4136, stroke-width:2px; -linkStyle 1 stroke:#1ABC9C, stroke-width:2px; +%% linkStyle 0 stroke:#FF4136, stroke-width:2px; +%% linkStyle 1 stroke:#1ABC9C, stroke-width:2px; ``` ## About this repository