docs: add Mermaid architecture diagram and script reference table#1
Open
Prometheus1400 wants to merge 1 commit into
Open
docs: add Mermaid architecture diagram and script reference table#1Prometheus1400 wants to merge 1 commit into
Prometheus1400 wants to merge 1 commit into
Conversation
- Add visual system architecture diagram showing device fleet, GitHub cloud, core scripts, and hidden engine components - Include script reference table with purpose and sync direction - Makes the multi-device sync ecosystem easier to understand at a glance
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 and script reference table to help visualize and understand the multi-device sync ecosystem.
Changes
Mermaid Diagram: Visual flowchart showing:
~/.shortcuts/) and their relationships.hidden/)rsync --deleteandgit reset --hardScript Reference Table: Quick lookup for what each script does and which direction it syncs
Why
The original README described the components but didn't provide a holistic view of how everything connects. The diagram makes it immediately clear:
Mermaid diagrams render natively in GitHub markdown, so no external tooling needed.