Diagram representation of the amazming-qr codebase #120
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.
Hi! This PR adds high-level diagrams of the amazing_qr codebase to help new contributors get up-to-speed.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/amazing-qr/on_boarding.md
The diagrams are designed to give high-level understanding of the full codebase, allowing new contributors to focus on one component at the begining, knowing how it fits with-in the big picutre. Considering that there are mroe than 1.6K stars, the number of contributors/people interested in the codebase itself is substantial, would love to hear if you think such docs can help!
We’ve also released a free GitHub Action that keeps the diagrams automatically updated as the code changes, so there's no ongoing maintenance burden.
Any feedback is more than welcome!
I'd usually open a discussion first, but you don't have them enabled for this repo so I decided to go ahead and open a PR.
Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.