[Docs] Added high-level diagrams #623
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I have generated high-level diagrams for the scirpy project. You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/scirpy/on_boarding.md
I suppose a lot of scientists (bio/bioinformatics etc.) interact with this codebase, I am sure that they are rather interested in the main flow and method then reading the source code in details. That is the main idea of the diagrams they show the main components and how they interact with each other. Then one can dive deeper by clicking on a component of interest. This allow scientists to quickly modify and extend the project as they can focus only on the component of interest with the full codebase context. I would love to connect and discuss how we can help!
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the diagrams so they are always up-to-date.
Seem irrelevant