Visualization of the face_recognition codebase #1649
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.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/face_recognition/on_boarding.md
The PR contains diagrams designed to help new contributors get up-to-speed with the codebase! Considerting you have the instance number of more than 13K forks, you have lots of people interacting with the codebase as contributors. We believe most of them are interested in a concrete module/component which they want to improve/customize. This said we think the diagrams are the best form of "onboarding" as they give overview of the full codebase and the new person can identify which component is of interest, then they can go deeper into it. Now they can see which source code is related to the component and have the context of how it interacts with the rest of the codebase. Let me know what is your opinion on the matter!
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 love to hear if there is something else I can help with!
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.