docs: pimp out readme with blob lifecycle diagrams #233
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
We changed the name in README so should be consistent in the code
litt3
reviewed
Jan 22, 2025
Posting Blobs -> Posting Payloads Retrieving Blobs -> Retrieving Payloads
litt3
approved these changes
Jan 23, 2025
bxue-l2
approved these changes
Jan 23, 2025
resources/sequence-diagram.png
Outdated
There was a problem hiding this comment.
Do you want to use the updated the chart, Austin and us draw yesterday
There was a problem hiding this comment.
Good call! sorry merged this PR before seeing your comment. Created #256 to change the image
Add some intro section, and add links to Integration Guide
samlaf
deleted the
samlaf/pimp-out-readme-with-blob-lifecycle-diagrams
branch
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.
We have a full spec coming so perhaps some of the stuff here will be redundant and we can remove it and just point to the spec once it's ready. But in the meantime I think it's good to have more (rather than less) info.
Main changes include:
Fixes Issue
Fixes #
Changes proposed
Screenshots (Optional)
Note to reviewers