Adding interactive diagrams to the documentation

[brovatten]

Hi,

I built CodeBoarding, an open-source tool that generates interactive architecture diagrams (static analysis + LLM) to help contributors and users navigate Python repos.

I believe this would be a useful addition to the existing docs. Please see the diagram below and see if you agree:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/typeguard/on_boarding.md

Let me know if you are interested in adding this to typeguard and I would happily make a PR!

[agronholm]

I had to do several takes on that diagram to understand what it's trying to say, and it still left me confused. And I wrote most of the code. Given that, I'm not sure it would actually help prospective users. Thoughts?

[agronholm]

As for the sub-diagrams and their explanations, they're pretty much the same way. I don't think they will help prospective users understand this any better. I really don't see much value in any AI generated content in programming, at least at this stage.

[brovatten]

Hi @agronholm, and thank you for the reply. Your comment "And I wrote most of the code" made me really curious to hear what parts of the diagram you thought were incorrect. The release is only two weeks old - and I am still working actively on making it as accurate as possible. Thanks so much!