Skip to content

Feat: Sequence Diagram SVGs into Mermaid renders#794

Open
hanzalahwaheed wants to merge 2 commits intoprecice:masterfrom
hanzalahwaheed:feat/mermaid-sequence-diagrams
Open

Feat: Sequence Diagram SVGs into Mermaid renders#794
hanzalahwaheed wants to merge 2 commits intoprecice:masterfrom
hanzalahwaheed:feat/mermaid-sequence-diagrams

Conversation

@hanzalahwaheed
Copy link
Contributor

@hanzalahwaheed hanzalahwaheed commented Feb 23, 2026

Fixes #792

I've tried to convert the diagrams into mermaid renders. Here are the tow outputs that I have. Need help choosing the better one.

serial coupling diagram

reference: https://precice.org/couple-your-code-coupling-flow.html

original screenshot

image

mermaid render A

This is a more direct one-to-one mapping of the diagram.

image

mermaid render B

This is a more semantic render.

image

@MakisH which one do you think is a better render? I'm inclined towards A but the loop box of B is also nice.

@MakisH
Copy link
Member

MakisH commented Feb 24, 2026

Thank you @hanzalahwaheed, this is useful. We will eventually review it and see how it might work together with other documentation as well.

@MakisH MakisH added technical Technical issues on the website GSoC Contributed in the context of the Google Summer of Code labels Feb 24, 2026
@precice-bot
Copy link
Contributor

This pull request has been mentioned on preCICE Forum on Discourse. There might be relevant details there:

https://precice.discourse.group/t/gsoc-2026-introduction-hanzalah-waheed/2745/5

@MakisH MakisH added content Content-only issues and removed technical Technical issues on the website labels Mar 14, 2026
@MakisH
Copy link
Member

MakisH commented Mar 14, 2026

Overall, I think this is nice for new graphs, but I am not yet convinced of the values that the Mermaid version of this figure would add. I would suggest not investing more work on this at the moment, let's just use this PR to evaluate the option.

Some comments, in arbitrary order:

  • The SGV (made with TikZ) also has some colors, which point to the two participants. Can we color boxes or text differently?
  • In "Approach A", the two participants seem like they are taking turns in calling initialize(). This is not correct: up to that point, they are decoupled. Similarly, in "Approach B", the calls to initialize() and finalize() seem to be one after another.
  • In "Approach B", I like the loop box.
  • In the SVG, the indentation relates to the different software layers, and it is nice to have.
  • An advantage of the SVG version is that it can easily be exported and used in a PDF document. How would we integrate Mermaid graphs there?

I tend towards not migrating this figure to Mermaid, but simpler/new figures would be fine to have directly in Mermaid. @fsimonis what do you think?

@MakisH MakisH changed the title Feat: Sequnce Diagram SVGs into Mermaid renders Feat: Sequence Diagram SVGs into Mermaid renders Mar 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Content-only issues GSoC Contributed in the context of the Google Summer of Code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Use mermaidjs for sequence diagrams?

3 participants