Visualization for the linode_api4-python codebase
📝 Description
What does this PR do and why is this change necessary?
This PR introduces high-level diagrams which map out the source code of your repository (You can see how they are rendered: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-linode-api/on_boarding.md). They are aimed to help new people get up-to-speed with the existing code. We believe that visuals are the best way to get started as they can easily give you high-level understanding and then you can dive deep into the components of interest.
We know that having up-to-date documentation is labourous task, so at the moment are looking into creating a Github action so that you can generate on demand such docs. I would love to hear what do you think about diagram first documentation. Further do you have any process for onboarding atm and what it looks like?
Lastly, we use static analysis and LLMs to generate the diagrams and for now support python.
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.
✔️ How to Test
It is just documentation so no need to test it.
📷 Preview
You can see how the change would render in your repository here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/python-linode-api/on_boarding.md
If applicable, include a screenshot or code snippet of this change. Otherwise, please remove this section.
A quick update, we are an open-source project now! https://github.com/CodeBoarding/CodeBoarding