[Docs] Visualization of the metaflow codebase #2448
+886
−0
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 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.