add ascii art #16
Merged
add ascii art #16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ichabond
reviewed
Jan 26, 2024
| @@ -93,6 +93,62 @@ Using the token bearer model ([RFC6750](https://datatracker.ietf.org/doc/html/rf | |||
| # Example Request Flow | |||
| For a diagram, please see: https://github.com/bgp/autopeer/blob/main/README.md#sequence-diagram | |||
|
|
|||
There was a problem hiding this comment.
As per
https://github.com/cabo/kramdown-rfc/blob/master/examples/stupid-s.mkd
You should "box" this diagram with
~~~~~~~~~~
There was a problem hiding this comment.
@Ichabond oh, good catch, thanks. I guess I should do a local install and check how the rendering works.
There was a problem hiding this comment.
You can check the build artifacts here, too: https://github.com/bgp/draft-ietf-peering-api/actions/runs/7659907136
Let's see if it works with the ~~~?
|
Looks nice to me! Thanks for putting it together. Fine by me to merge once it renders correctly in the artifact. |
jramseyer
approved these changes
Jan 26, 2024
|
resolved merge conflicts |
I think this fixes the formatting? Just based on the example in https://github.com/cabo/kramdown-rfc/blob/master/examples/stupid-s.mkd?plain=1
Format diagram for draft
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add ascii representations of the mermaid docs. They are hand made and I'm not sure it makes sense to diagram more than the Auth loop part.
It does look like we can have the svg rendered for the html views [0], using our github actions template [1]. Should we look at adding both or leave it as is for the first version?
[0] https://authors.ietf.org/diagrams
[1] https://github.com/cabo/kramdown-rfc/wiki/SVG