Convert Sequence Diagram img to mermaid #51723
Merged
Conversation
This file contains 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
zmb3
reviewed
Jan 31, 2025
| @@ -248,7 +248,34 @@ resource availability as possible. | |||
|
|
|||
| ### PTY communication overview (Renderer Process <=> Shared Process) | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
Should we delete this file too?
There was a problem hiding this comment.
@zmb3 We should!
When we do delete the image, I now notice that would only leave the txt source within the docs dir /docs/ptyCommunication.txt, which is redundant to the mermaid syntax we now have, inline, within the README.
Should we delete the entire dir in favor of keeping everything in the README?
There was a problem hiding this comment.
Removed docs dir and contents: 87d6c7f
zmb3
approved these changes
Jan 31, 2025
flyinghermit
approved these changes
Jan 31, 2025
public-teleport-github-review-bot
bot
removed the request for review
from jimbishopp
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.
changelog: replaces the static png image to the language based mermaid sequence diagram with support for GitHub markdown rendering.
Before:
After:
Playground:
https://www.mermaidchart.com/app/projects/e27e8be9-380e-4b27-b5d9-7dd2f66c0eef/diagrams/ba72f37b-324a-4450-938b-f04ba6cfc476/version/v0.1/edit