Added World pseudo-UML diagram to diagrms README.md #1
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
added 6 commits
June 14, 2018 01:27
|
Also, I'll send a shared link to the lucidchart file for the psuedo-UML on the gitter chat so that others may contribute. Not sure how to bring lucid chart into VCS at the moment however. |
|
And here's a link to what's being requested: https://github.com/krunoPeric/diagrams since it's not as clear from all the commits. |
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.
When I first looked into adding diagrams to the docs for RadixEngine, I setup Doxygen's config to generate UML for classes and I ended up with a very large web that was difficult for me to digest.
Perhaps that is why diagrams aren't enabled in the docs :)
So what instead, I worked out the basic, high-level function of World and created a sort of pseud-UML diagram of it with annotations to supplement the data flow diagram in here. I think this might save time for new contributors and has potential to reduce the "Hacktivation Energy" of the project. Let me know your thoughts!