Skip to content

Conversation

@ivanmilevtues
Copy link

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.

@ivanmilevtues
Copy link
Author

A quick update on our side, since last Wednesday we are open-source: https://github.com/CodeBoarding/CodeBoarding
You can have a look and see exactly how the generation works if interested!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant