Skip to content

Visualization for the linode_api4-python codebase #562

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: dev
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

📝 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.

@ivanmilevtues ivanmilevtues requested a review from a team as a code owner June 9, 2025 12:37
@ivanmilevtues ivanmilevtues requested review from jriddle-linode and yec-akamai and removed request for a team June 9, 2025 12:37
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