Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Images to Orchestration Docs #1238

Merged
merged 2 commits into from
Oct 16, 2024
Merged

Adding Images to Orchestration Docs #1238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67ec59e
chore: orchestration graphics update
mujahidkay Oct 12, 2024
a15322c
chore: update chain graphics
amessbee Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added main/guides/orchestration/assets/chains.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed main/guides/orchestration/assets/icaoverview.png
View file
Open in desktop
Binary file not shown.
Binary file removed main/guides/orchestration/assets/orca.png
View file
Open in desktop
Binary file not shown.
Binary file removed main/guides/orchestration/assets/orca2.png
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions main/guides/orchestration/assets/orch_contract_arch.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions main/guides/orchestration/how-orch-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ To achieve these goals, several foundational technologies and protocols have
been developed, with the [Inter-Blockchain Communication (IBC) protocol](https://ibcprotocol.org/) being
one of the most prominent.

<br/>
<img src="./assets/orch_contract_arch.svg" width="100%" />
<br/>

### Inter-Blockchain Communication (IBC)

The [Inter-Blockchain Communication (IBC) protocol](https://ibcprotocol.org/)
Expand Down
4 changes: 4 additions & 0 deletions main/guides/orchestration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ The Agoric Orchestration API sits on top of Agoric’s novel VM that provides th

Agoric’s Orchestration APIs simplify controlling accounts on remote chains, moving assets, and using capabilities on any chain the API reaches.

<br/>
<img src="./assets/chains.png" width="100%" />
<br/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice figure. I'd like to see it right after the 1st paragraph (ending "novel cross-chain-focused products.")

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, how do we maintain it? Is this .svg file the editable source form? What tool did you use to create it?

Copy link
Contributor Author

@amessbee amessbee Oct 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dckc I created the original image using latex in ipe tool, and yes this was SVG.

As per offline comments by @toliaqat I have updated the image with a new version, and moved it to how-orchestration-works page. This image uses the original source image from Agoric Orchestration Docs document and was created using Canva online editor for which SVG is not available.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Canva? I found it in some Google slides. Here's an SVG export:

orch-arch

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dckc can you update the text in "User Story" box as per the image mudassir uploaded, and reupload the SVG?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think svg vs png is a debate that should delay improving docs. We already have both kinds of images in the repo and they solve the problem at hand. Optimizing the format should come when we have learned enough after many iterations and have nothing else to improve.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... We already have both kinds of images in the repo and they solve the problem at hand.

Yes; we use .png for screenshots and, until now, we used .svg for diagrams.

Optimizing the format should come when we have learned enough after many iterations and have nothing else to improve.

So only after many iterations we should consider accessibility? That's not a position I'm prepared to support.

https://www.ohchr.org/en/instruments-mechanisms/instruments/convention-rights-persons-disabilities#article-9


## Orchestration Overview

Agoric's Orchestration API is a tool to help developers build seamless applications out of disparate interoperable chains and services. This composability allows for the development of user-centric applications that leverage the unique strengths of different blockchain ecosystems.
Expand Down
Loading