Skip to content

Conversation

ivanmilevtues
Copy link

Generated documentation to help new developers to get up to speed with the pyautogui.

Me and a friend have noticed that it is quite hard to get to know new codebases, so we are working on something which can help people get up to speed and thus reducing the load for both maintainers and new devs. We believe that it is always best to start with nice high-level visualization and then dig down into the interesting/relevant parts of the code i.e. first task/something one wants to contribute to.

This said, we generated diagrams leveraging static analysis and LLM's. I generated one for the pyautogui you can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pyautogui/on_boarding.md

Would love to hear your opinion on the diagrams and on diagram first documentation in general, any feedback is more than welcome!

I usually open discussions, but they are not enabled for this project so I decided to directly open a PR :)

Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.

@ivanmilevtues
Copy link
Author

Hey, dropping by to update you that we are open-source now: https://github.com/CodeBoarding/CodeBoarding

@KavyanshKhaitan2
Copy link

Very detailed for PyAutoGUI, especially because the project itself is implemented in a very simple manner.

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.

2 participants