Update architecture diagrams #1215
Merged
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
WardBrian
added
cleanup
|
Wow nice, when was this added. |
rok-cesnovar
approved these changes
Jun 17, 2022
|
Earlier this year, somehow months before they finally added |
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.
Now that Github natively supports diagrams like flowcharts and since we may be doing some architectural changes soon in #1182 #1184, I thought it would be good to update our existing diagrams/prose a bit.
By embedding it directly it keeps it self-documenting, responds to the viewers dark/light mode setting, and the nodes are even clickable to take you to the files mentioned.
Preview here:
https://github.com/WardBrian/stanc3/blob/update-architecture-docs/README.md
Submission Checklist
Copyright and Licensing
By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the BSD 3-clause license (https://opensource.org/licenses/BSD-3-Clause)