Diagram visualization of the flair codebase #3678
Open
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 diagram representation of the codebase for flair.
You can see how it renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/flair/on_boarding.md
With over 2k forks it is clear that a lot of people play around with the codebase. This said most of them probably want to just adjust certain aspect of the codebase, and with the proposed diagrams they can navigate it much faster and contribute with better understanding. Let me know if you share my view here.
Usually I'd open a discussion first, but they are not enabled for this repo! This said any feedback is more than welcome!
I saw that you are using .rst files for docs (Sphinx?). We have a free ghub action to keep the diagrams up-to-date. So if you like what you see I'd be more than happy to integrate it for you!
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.