Skip to content

Visualization of the codebase #6870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant