Visualization for the ChEMBL_Structure_Pipeline #56
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 all, a quick follow-up. Since last Wednesday our diagram generation engine is fully open-source: https://github.com/CodeBoarding/CodeBoarding |
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.
This PR contains high-level diagrams for the ChEMBL_Structure_Pipeline codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/ChEMBL_Structure_Pipelinec/on_boarding.md
These diagrams are designed to help people quickly understand a codebase. I believe many scientists look into this codebase. Our goal is to reduce the time it takes them to get up to speed—from hours to just minutes—by using visuals (diagrams) instead of reading through the entire code. I'd love to hear where do stand on diagram first documentation for codbases!
We’d love any feedback! We also just released a free GitHub Action that can automatically update the docs.
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.