Skip to content

Conversation

ivanmilevtues
Copy link

This PR contains documents which visualise the codebase of the metaflow project through mermaid diagrams.
You can see how the whole thing renders here: https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/metaflow/on_boarding.md

The idea is that such documents can give high-level understanding of the codebase to people who are new to it. This way they can focus on interesting parts (components) of the codebase with knowing how they fit in the big picture. I would love ot hear what is your current process of on-boarding in Netflix and do you think that such diagrams can fit into it :).

Any feedback is more than welcome! Just to clarify we are building these diagrams with Static analysis and LLMs, and currently working on a GitHub Action, so that you can have them always up-to-date!

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 https://github.com/CodeBoarding/CodeBoarding is now open-source! You can check how the generation works in details now :)

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