diagram key (docs)

[dckc]

As a user, I want to be able to navigate (perhaps via a help/docs button) to a diagram key as as the one in Aug 23 notes:

---

The participants in the state diagram are vats.

Arrows represent messages between vats.

A solid arrow labelled:

0.1 kp13858945 <- ko1009519.fromBridge(866)

That means: at 0.1 seconds into the block, a message with method fromBridge and 866 characters of arguments was sent to kernel object ko1009519, allocating a promise kp13858945 for the result.

An arrow with kp13858945.fulfilled() means the promise was fulfilled. An arrow with kp13858945.rejected() means it was rejected.

An arrow whose tail is the left edge of the diagram means the script couldn't figure out which vat it came from. (Some messages come from the kernel.)

Yellow boxes indicate large computron counts.

[rabi-siddique]

@dckc I want to ensure I fully understand your idea. Could you elaborate a bit more on "navigate (perhaps via a help/docs button) to a diagram key"?

[dckc]

I gave a suggested diagram key above. That much is clear, yes?

The rest is: add a "help" or "docs" link on https://causeway.agoric.net/ to docs that include such a diagram key. Maybe a pop-up window?

[rabi-siddique]

I gave a suggested diagram key above. That much is clear, yes?

I might not have been at my sharpest when I first looked at it, but it’s clear to me now.

The rest is: add a "help" or "docs" link on https://causeway.agoric.net/ to docs that include such a diagram key. Maybe a pop-up window?

A popup window is not a bad option. I can try that.
Do you think it should be right next to the diagram? This is mainly so that viewers can quickly reference it without losing context.

[dckc]

Next to the diagram is fine, I expect.

Feel free to experiment