Diagram documentation

[brovatten]

First of all, thanks a lot for maintaining!

I'd like to propose integrating CodeBoarding into your documentation.

It's a code visualization project I recently open-sourced. It helps contributors and users better understand the repository’s structure. CodeBoarding uses static analysis and an LLM pass to generate accurate, interactive diagrams that show the high-level architecture and allow drilling down into specific modules or functions.

I've generated a sample diagram for this repo so you can see what it looks like:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytest-xdist/on_boarding.md

Please let me know if you think this would be useful for the community, and I would be happy to open a PR, thanks.

[RonnyPfannschmidt]

At first glance its confused about finer details and uses highly problematic legacy wording

[brovatten]

Thanks for the reply @RonnyPfannschmidt . If you have time, it would be really helpful if you could give me an example so I can improve this for the underlying engine :)

[The-Compiler]

Previously: pytest-dev/pytest#13498

And OP plus their co-founder (or second account?) are posting this in hundreds of open source projects: https://github.com/search?q=codeboarding&type=discussions

This is spam (paired with AI slop) in my book, plain and simple. I doubt a human ever took a look at that markdown output and the source code of the projects they're posting it in. But I'm sure OP (and @ivanmilevtues) are somehow thinking they're helping open source maintainers with this 🤷,

[brovatten]

Hey @The-Compiler, thanks for pointing that out. I should have checked for existing discussions first. Sorry that the diagrams weren’t useful in this case - I’ll go ahead and close the discussion. I understand they won’t always be helpful, for some projects the diagrams are more accurate than in others