Skip to content

Conversation

@ivanmilevtues
Copy link

Hi! This PR adds high-level diagrams of the academic-keyword-occurrence codebase to help new contributors get up-to-speed.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/academic-keyword-occurrence/on_boarding.md

The diagrams are designed to give high-level understanding of the full codebase, allowing new contributors to focus on one component at the begining, knowing how it fits with-in the big picutre. Would love to hear if you think such docs can help, and it would be awesome to connect and discuss if we can help in any other way!

We’ve also released a free GitHub Action that keeps the diagrams automatically updated as the code changes, so there's no ongoing maintenance burden.

Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.

@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