search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 39 forks source link

Multiple Files for Sequence Diagrams #1242

Open amessbee opened 5 days ago

amessbee commented 5 days ago

ATM, for each sequence diagram (e.g. one at the bottom of https://docs.agoric.com/guides/orchestration/) in documentation, we are keeping two files

This is a potential duplication of information that requires more than required amount effort to maintain.

dckc commented 4 days ago

This increases dependence on client-side JavaScript. Before this change, the source (from curl) includes:

... cross-chain transactions.</p><br><img src="/assets/orchestration-workflow-1.CN3JBV8-.svg" width="100%"><br></div>

but with this change, we get:

... cross-chain transactions.</p><div class="mermaid"></div>

It's not clear why JavaScript should be required for static images.

dckc commented 4 days ago

The indirect dependencies brought in by vitepress-plugin-mermaid include d3, katex, vscode-languageserver, and so on. I wonder if all that is worthwhile.

amessbee commented 3 days ago

This increases dependence on client-side JavaScript. Before this change, the source (from curl) includes:

... cross-chain transactions.</p><br><img src="/assets/orchestration-workflow-1.CN3JBV8-.svg" width="100%"><br></div>

but with this change, we get:

... cross-chain transactions.</p><div class="mermaid"></div>

It's not clear why JavaScript should be required for static images.

I don't know enough javascript to be sure, but I believe <div class="mermaid"> is just a static stylesheet class to be (optionally) defined by us, and does not affect the rendering of svg if you remove or change it (in a not-so-adversarial way I suppose).

dckc commented 3 days ago

It's not clear why JavaScript should be required for static images.

I don't know enough javascript to be sure, but I believe <div class="mermaid"> is just a static stylesheet class to be (optionally) defined by us, and does not affect the rendering of svg if you remove or change it (in a not-so-adversarial way I suppose).

<div class="mermaid"> affects the rendering of the svg image in that (without JavaScript) it provides no rendering whatsoever. Not even a link where you could download the image. Note the lack of an <img> element.