docs: 📝 add combined C4 component and code diagram #154
Conversation
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
Only including a diagram for the core Python package, not one for the future CLI.
lwjohnst86
requested changes
Oct 27, 2025
Member
lwjohnst86
left a comment
lwjohnst86
left a comment
There was a problem hiding this comment.
Very nice! Only one change needed
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
Rather than "custom checks"
… (`-s`) I believe it's third-person singular simple-present tense to be specific.
And the plans to support additional versions later on.
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
github-project-automation
bot
moved this from In Progress
to Done
in Iteration planning
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
This PR adds a combined C4 component/code diagram for the core Python package. It kind of mirrors the existing flow diagram in the interface docs. I initially made a more detailed version trying to mirror the implementation more closely, but for the purpose of this, I think this might be fine with this level of detail.
Related to #46
Needs an in-depth review.
Checklist
just run-all