Skip to content

Conversation

@ivanmilevtues
Copy link

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

The idea is to make onboarding easier—especially for open-source contributors who typically want to work on a specific module. Visualizing the codebase helps people understand how things fit together without needing to read everything up front. With more than 2.3K forks, you have a lot of contributors who are not just users, but rather want to fiddle around with the codebase itself. With the visualization they can see the big picture and focus only on the component they are interested in.

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.

Any feedback is more than welcome!

I'd usually open a discussion first, but you don't have them enabled for this repo so I decided to go ahead and open a PR.

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

A quick update, our generation engine is now open-source: 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