Skip to content

Conversation

ivanmilevtues
Copy link

This PR includes documentation enhanced with Mermaid diagrams that represent the codebase at a high level. You can view how they’re rendered here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/foxops/on_boarding.md

The idea of the diagram is to give people an easy way into the codebase. Showing what the main components are and how they interact with eachother gives a high-level understanding of how things work for new people. Then they can focus on the component of interest and start building their knowledge from there.

I would love to hear your feedback on the idea and execution! If you like it, I'd be more than happy to do a PR, where I integrate the diagrasm in your /docs + our free github action to keep them 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 ivanmilevtues requested a review from defreng as a code owner July 4, 2025 23:46
@ivanmilevtues
Copy link
Author

Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding

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