Visualization of the codebase #2419
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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! |
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 2 - JSON files created/updated: 3 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .rst - Repository analyzed: https://github.com/CodeBoarding/ChatterBot - Destination: docs/architecture/ 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 4 - JSON files created/updated: 5 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .rst - Repository analyzed: https://github.com/CodeBoarding/ChatterBot - Destination: docs/architecture/ 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 4 - JSON files created/updated: 5 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .rst - Repository analyzed: https://github.com/CodeBoarding/ChatterBot - Destination: docs/architecture/ 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.