[Docs] Adding diagram visualization for deepTools #1408
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.
Welcome to deepTools GitHub repository! Please check the following regarding
your pull request :
In this PR I am introducing diagram first documentaiton. You can see how it renders here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/deeptools/on_boarding.md
The diagrams highlight the main abstract components and their interactions, enabling researchers to quickly understand the project's flow. Since many scientists focus on specific parts of the codebase—typically the methods rather than the infrastructure- these diagrams help them locate and edit relevant components within the full pipeline context.
Any feedback is more than welcome! We have introduced a github action which will keep the docs automatically up-to-date with new changes, I'd love to integrate that for you if you are interested.
Would love to connect and discuss how we can help!
Full disclosure: we're trying to turn this into a startup, but we're still in a very early stage and figuring out what will actually be useful for people.