Visualization of the KAZU codebase#87
Open
ivanmilevtues wants to merge 1 commit intoAstraZeneca:mainfrom
Open
Conversation
Author
|
A quick update on our side, since last Wednesday we are open-source: https://github.com/CodeBoarding/CodeBoarding |
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
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 KAZU codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/KAZU/on_boarding.md
The idea of these diagrams is to help people get up-to-speed with the codebase. I know that a lot of scientists interact with these codebases, the diagrams give imidiate context on the full pipeline of the project, with that context a person can focus on the components of interest. I would love to hear what do you think about Diagram first documentation for on-boarding and if it fits in your existing on-boarding processes.
Any feedback is more than welcome! We also have a free github action out now, which can automatically updated the docs at merge in main or other heuristic (let me know what you think about that)
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.