Visualization of the AfterQC codebase #46
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
Author
|
A quick update! CodeBoarding is now 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
1 participant
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 AfterQC codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/AfterQC/on_boarding.md
These diagrams are designed to help people quickly understand a codebase. There are a lot of scientists who engage with this codebase, and we want to help them get up-to-speed faster. We believe that visuals are the easiest way to do that. With the diagrams they can immediately gain context and find the component in which they are interested and get knowledge of that and see what files are connected to it. I am super curious to hear what you think about diagram first documentation. I'd usually first open a discussion, but they are not enabled for this repo, so I went ahead and opened a PR.
Any feedback is more than welcome! We also just released a free GitHub Action that can automatically update the documentation.
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.