Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added WIP mermaid architecture diagram #1086

Merged
merged 2 commits into from
Jul 13, 2024

Conversation

ErikBjare
Copy link
Member

@ErikBjare ErikBjare commented Jul 10, 2024

🚀 This description was created by Ellipsis for commit 9e65022

Summary:

Added a Mermaid architecture diagram to README.md to illustrate system component relationships.

Key points:

  • Added Mermaid architecture diagram to README.md
  • Diagram illustrates relationships between components like aw-qt, aw-server, aw-watcher-window, aw-watcher-afk, aw-watcher-web, and aw-webui
  • No changes to code or functionality

Generated with ❤️ by ellipsis.dev

@ErikBjare ErikBjare marked this pull request as ready for review July 13, 2024 14:48
@ErikBjare
Copy link
Member Author

Merging this, to be improved/moved later.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Changes requested. Reviewed everything up to 9e65022 in 25 seconds

More details
  • Looked at 58 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_tppn5jNKePnWVTC4


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

S <-- aw-sync --> SF[Sync folder];
S -- Serves --> UI[aw-webui];

%% User -- Interacts --> UI;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commented-out class definitions and link styles in the Mermaid diagram are not used and could be removed to avoid clutter and confusion in the documentation.

@ErikBjare ErikBjare merged commit 43cbad1 into master Jul 13, 2024
9 checks passed
kevich pushed a commit to kevich/activitywatch that referenced this pull request Sep 17, 2024
…tyWatch#1086)

* docs: added WIP mermaid architecture diagram

* docs: improvements to WIP mermaid diagram
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant