docs: add program flow diagram as SVG to README#3
Conversation
Generated a sequence diagram using Mermaid JS to visualize the UNIX socket single-instance logic. Added the generated `flow.svg` to the `assets/` directory and embedded it in the `README.md`.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Generated a sequence diagram using Mermaid JS to visualize the UNIX socket single-instance logic. Added the generated `flow.svg` to the `assets/` directory and embedded it in the `README.md`. Also formatted `lib/src/unix_single_instance_base.dart` with latest dart format to fix CI format check failing due to GitHub Action token permissions.
There was a problem hiding this comment.
@jules I was hoping for more a flow chart from the external users perspective. Can you also include agents.md to update this?
There was a problem hiding this comment.
I've replaced the sequence diagram with a flowchart depicting the flow from the external user's perspective. I've also added an AGENTS.md file with instructions on how to regenerate the SVG from the flow.mmd source file.
There was a problem hiding this comment.
@jules good but a little too simplistic / not helpful enough as to how internal messaging is done, or what the user is to expect. Or how the different flags cause different paths to execute
There was a problem hiding this comment.
I've updated the flowchart to be much more detailed. It now shows the internal messaging (JSON encoding/decoding), how active and dead connections are handled, and how the different errorMode flags dictate the final path execution.
Replaced the sequence diagram with a flowchart depicting the external user's perspective, per PR review feedback. Added `AGENTS.md` containing instructions on how to regenerate the SVG diagram from `flow.mmd` using Mermaid CLI.
There was a problem hiding this comment.
@jules since this just whitespacing can you remove this from the commit, so I don't need to do a merge conflict?
There was a problem hiding this comment.
I've reverted the formatting changes to lib/src/unix_single_instance_base.dart to avoid any merge conflicts.
There was a problem hiding this comment.
@jules good but a little too simplistic / not helpful enough as to how internal messaging is done, or what the user is to expect. Or how the different flags cause different paths to execute
Reverted `lib/src/unix_single_instance_base.dart` to avoid merge conflicts and removed it from this PR. Updated the Mermaid diagram (`flow.mmd`) to contain a much more detailed flowchart outlining internal messaging paths, JSON serialization, dead socket cleanup, and error handling branching based on flags. Regenerated `assets/flow.svg`.
1 participant
Adds a Mermaid JS sequence diagram to the
README.mdto visually document the program's single-instance UNIX socket logic. The SVG is embedded in theREADME.mdunder a new "Program Flow" section.PR created automatically by Jules for task 17111189724105092746 started by @arran4