Description
I am creating this issue as a follow up from #11668. Big thanks to @TensorCruncher for the support.
Based on the positive feedback, I’d like to propose a small documentation improvement for diffusers: integrating a visual onboarding diagram to help new contributors and users better understand the structure of the codebase.
Our goal is to ease that process by generating diagrams that give a high-level overview of the architecture, main modules, and flow within the codebase.
We’ve created a diagram which you cna preview here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/diffusers/on_boarding.md that aims to do just that. Before opening a PR, I wanted to collect feedback here from maintainers and contributors:
Would a diagram like this be a helpful addition to the official docs (README.md or CONTRIBUTING.md or doc-builder for docs)? Further we also have a free github action which can keep those docs up-to-date with new commits, I can fully integrate that for you if you are interested.
Full disclosure: we are in the very early stages of turning this into a startup focused on improving open source onboarding — but our current priority is making sure this genuinely helps communities like this one.
Happy to iterate based on feedback and open a PR if there’s interest and also super interested to connect and discuss how we can help!