Visualization for the atlassian-python-api codebase

[ivanmilevtues]

Generated documentation to help new developers to get up to speed with the atlassian-python-api.

Hey all. 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 atlassian-python-api project.
You can see how the added change renders in the github markdown here - https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/atlassian-python-api/on_boarding.md

Would love to hear your opinion on the diagrams. Further I know atlassian is a big company so I suppose there is some process already in place, can you share some details on what it looks like, do you think such diagrams can fit into it? Further what is your opinion on diagram driven on-boarding?

Any feedback is more than welcome!

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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 33.63%. Comparing base (a3023c4) to head (b17b17a).
⚠️ Report is 31 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1543   +/-   ##
=======================================
  Coverage   33.63%   33.63%           
=======================================
  Files          48       48           
  Lines        9299     9299           
  Branches     1249     1249           
=======================================
  Hits         3128     3128           
  Misses       6048     6048           
  Partials      123      123           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[gonchik]

@ivanmilevtues Let me merge.
Actually it will be quite simple for that wrapper.

more dynamics will be nice :)