SEP-31: Add mermaid sequence diagram #1145
Conversation
| * `v1.5.0`: Deprecate refunded boolean. Add refund object to transaction records. ([#1128](https://github.com/stellar/stellar-protocol/pull/1128)) | ||
| * `v1.5.1`: Add a sequence diagram for successful transactions using firm quotes. ([#1145](https://github.com/stellar/stellar-protocol/pull/1145)) |
There was a problem hiding this comment.
Can you put this at the top of the change log so the change log is ordered descending? Most recent changes are the most interesting to folks.
|
|
||
| This diagram demonstrates the interactions between the entities involved in a successful transaction. Specifically it uses the [Receiving Anchor Asset Conversion](#receiving-anchor-asset-conversion) strategy defined described later in the document. | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
This diagram looks great. 👏🏻
One thing I noticed is that it renders with a massive blank area at the bottom of the diagram. Do you know why this is? Is this a @github bug, or something to do with how we've defined the diagram do you think?
Here's a screenshot of what I see:
There was a problem hiding this comment.
I see the same thing, but I don't see anything wrong with the diagram syntax. Let me google a bit to see if this is a known issue.
There was a problem hiding this comment.
There was a problem hiding this comment.
This looks great, great idea.
I don't think we need to block merging this on the rendering issue. It is likely a GitHub bug. It could be worthwhile creating a discussion thread about this bug at https://github.com/github/feedback/discussions/categories/general-feedback or sending a message to GitHub Support.
Adds a "Diagrams" section to SEP-31 and starts with a happy-path sequence diagram.
We've discussed whether or not to include diagrams in our SEPs several times in the past and have historically decided not to do so due to the additional burden of maintaining another document. However, now that Github has added support for mermaid syntax, we can keep the SEP as the single source of truth and edit diagrams directly as markdown.