Improve Onboarding with Generated System Diagrams

[ivanmilevtues]

This PR adds auto-generated high-level diagrams and component-level documentation using CodeBoarding, aimed at improving developer onboarding by making it easier to get to know the codebase and lowering the barrier to contribution.

We would love to hear what you think about the generated diagrams — feedback is more than welcome. If you are interested in using CodeBoarding for other projects or want to get in touch, feel free to reach out to me.

[koalalorenzo]

Than you for the contribution @ivanmilevtues!

I am not interested in CodeBoarding or AI tools contributions like this one. The code was designed to have inline docs and docs accessible via python itself, following the same structure as the upstream APIs :(

Even if I appreciate the intent ( I do ;-) ), I will close this PR, but please avoid pushing code or contributions generated by AI or LLMs.

[ivanmilevtues]

Thanks for the response @koalalorenzo! I understand the inline docs, however our goal is more to help people who are brand new to the codebase and need more of an overview.

I wonder, why is it that you don't like about LLM content. In our case we use a lot of static analysis before the LLM step. What could make you swing the other way in the more general case not in particular for our application :)