Visualization of the codebase #6870
Open
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.
With this PR, I intorduce diagrams representation for the PySimpleGUI project to help new contributors orient themselves in the codebase.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/PySimpleGUI/on_boarding.md
PySimpleGUI has nearly 2k forks -> many developers are exploring the codebase—likely focusing on specific components. That’s why we think that diagram-first documentation can help - with it users can quickly locate the part they care about and understand how it fits into the larger system. What’s your take on this approach?
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.
Any feedback is more than welcome!
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.