gunthercox
Visualization of the codebase
This PR adds a diagram-based representation of the ChatterBot codebase.
You can preview the diagram rendering: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/deepface/on_boarding.md
With over 4.5K forks, it’s clear many developers explore this codebase—likely focusing on specific components. Diagram-first documentation helps them quickly locate areas of interest and understand how those components fit into the bigger picture.
I noticed you use Sphinx for docs—if you're interested, I’d be happy to integrate our free GitHub Action to keep diagrams automatically updated.
Normally I’d start a discussion, but since they're disabled, I opened this PR instead. Feedback is very welcome!
Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.
Hey a quick update from our side, we've just released our diagram generation engine as an open-source repo: https://github.com/CodeBoarding/CodeBoarding
If you are interested to run it yourself or how exactly the generation works you can take a look!
Sorry for the late reply, these diagrams are visually very nice (huge fan of the mermaid js library).
If there was a way to integrate these into the Sphinx documentation generator (https://www.sphinx-doc.org/en/master/) and have these generate within the existing documentation when it gets built - that would be amazing and I would definitely consider adding these.
@gunthercox awesome that you like them, it is possible and I will make the integration and get back to you in the upcoming few days!