docs: added WIP mermaid architecture diagram #1086
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Merging this, to be improved/moved later. |
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Changes requested. Reviewed everything up to 9e65022 in 25 seconds
More details
- Looked at
58lines of code in1files - Skipped
0files when reviewing. - Skipped posting
0drafted 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; |
There was a problem hiding this comment.
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.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Added a Mermaid architecture diagram to
README.mdto illustrate system component relationships.Key points:
README.mdaw-qt,aw-server,aw-watcher-window,aw-watcher-afk,aw-watcher-web, andaw-webuiGenerated with ❤️ by ellipsis.dev