Tree: Readme diagrams #11590
Merged
Tree: Readme diagrams #11590
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
github-actions
bot
added
area: dds
yann-achard-MS
approved these changes
Aug 18, 2022
jenn-le
approved these changes
Aug 19, 2022
packages/dds/tree/README.md
Outdated
| @@ -97,7 +110,14 @@ could be added in the future. | |||
|
|
|||
| #### Viewing | |||
|
|
|||
| TODO: add a diagram for this section. | |||
| ```mermaid | |||
| graph TD; | |||
There was a problem hiding this comment.
suggestion: A L->R graph might make this a bit easier to read. To me, top-down feels more like ownership rather than data flow (that might just be the pipe influence though).
There was a problem hiding this comment.
ya, that's much better. I didn't realize it was so easy to do that.
|
This commit is queued for merging with the |
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.
Description
Add a couple of architectural diagrams to Tree's readme
Reviewer Guidance
I'd like feedback on both the usefulness and accuracy of these diagrams.