Agoric / documentation

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

Adding Images to Orchestration Docs #1238

Closed amessbee closed 1 month ago

amessbee commented 1 month ago

Here are the changes:

  1. Adding an orchestration contract architecture graphic.
  2. Adding a graphic with potential connections between chains established through Agoric Orchestration.
  3. Updating sequence diagrams to use mermaid code directly in markdown.
  4. Removing unused assets.
cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: a15322c
Status: ✅  Deploy successful!
Preview URL: https://a93bea8a.documentation-7tp.pages.dev
Branch Preview URL: https://ms-add-orch-images.documentation-7tp.pages.dev

View logs

github-actions[bot] commented 1 month ago

Cloudflare deployment logs are available here

amessbee commented 1 month ago

@dckc @mujahidkay @toliaqat I am adding a vite plugin for mermaid that renders diagrams from within markdown and seems to work fine. This will save us from keeping both .mmd source file and the .svg graphic file and we can directly add the mermaid code to the markdown. I have updated the sequence diagram on Orchestration landing page - never mind rest of the mess on that page for now. I will update docs wherever we are using mermaid code unless there is a reason not to.

toliaqat commented 1 month ago

@amessbee I really like the mermaid code and rendering package—it’s great that it allows users to select and search text on the page. Thanks for adding that! However, I would have preferred it as a separate PR so we could review and merge the graphic and mermaid PRs independently.

amessbee commented 1 month ago

@amessbee I really like the mermaid code and rendering package—it’s great that it allows users to select and search text on the page. Thanks for adding that! However, I would have preferred it as a separate PR so we could review and merge the graphic and mermaid PRs independently.

Of course. Created a separate branch - here is PR #1243