Visualization for the linode_api4-python codebase #562
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.
📝 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.