Skip to content

Conversation

@ivanmilevtues
Copy link

This PR contains high-level diagrams for the genie codebase. You can see how they render in Github here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/genie/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 and I suppose they can make use of such diagrams and grasp the idea much faster than reading the code itself. 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

Hey all, a quick update since last Wednesday we are open-source: https://github.com/CodeBoarding/CodeBoarding
If you want to see how the generation works in detail you can check over there!

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