-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ZEP1: Apply review feedback for terminology section #163
ZEP1: Apply review feedback for terminology section #163
Conversation
…rage transformer definitions
This PR replaces the original PR alimanfoo#1, as we discussed to gather all PRs here onto the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- "Added two illustrations": 👍 and in general 💯 for any visual material since it helps the reader. (Downside will be keeping it in sync long-term)
- "The png files include the source" Interesting!
- Added examples to store terminology section 👍
- Improved the storage transformer terminology section 👍
- Reordered the terminology definitions slightly 👍
There's still a large re-reading outstanding from my side, but I don't see a reason not to get these in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is excellent, particularly the drawings. Thanks so much @jstriebel for these additions, which make the spec much more clear.
I have some minor editorial suggestions.
Thanks for sending this PR, @jstriebel. If I try to view the illustrations here, I can't view them properly. This is because they don't have a background colour. PS. I don't have a strong opinion on this, as I know these illustrations can be viewed on the web browser just fine. It's just the |
Co-authored-by: Ryan Abernathey <[email protected]>
6c395e5
@MSanKeys963 Good point, next time I'll add the white background, but I'd leave it as-is for now for simplicity. |
…-transformer-feedback-main
Unless we eventually enable dark mode for the specs as well ;) |
This PR applies some feedback from the ZEP1 review in #149. It adds illustrations to the terminology, and improves the store and storage transformer sections. In detail:
ZEP0001 - Core v3.0 spec for review #149 (comment)
ZEP0001 - Core v3.0 spec for review #149 (comment)
(moved codec and compressor more to the end, after the second illustration).
Screenshots of the rendered specs with the illustrations
(The changes from the ZEP1 review were applied to the main branch for the screenshots)