docs: add architecture markdown file to docs#45
Open
arjunsridhar12345 wants to merge 12 commits into
Open
Conversation
arjunsridhar12345
marked this pull request as ready for review
July 20, 2026 23:38
seanmcculloch
left a comment
seanmcculloch
left a comment
Collaborator
There was a problem hiding this comment.
This looks good but is a lot of content that will need to be kept up-to-date as things change across the repo and diagram. Seems difficult to maintain.
Deferring approval to Arielle regarding this and the overall structure/contents of architecture docs
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Tries to close #35. With lots of help from Claude, attempts to add detailed documentation on alignment with low-level diagram, reasoning for where and why things differed, while making sure to note that this is not final and that both the code and diagram serve each other.
Additionally, adds section on how to contribute with examples, and a section on how the composable parts can be used independently or together as seen in the pipeline.