Skip to content

Diagram visualization of the CosyVoice codebase #1411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ivanmilevtues
Copy link

In this PR I am adding high-level diagrams which represent the CosyVoice codebase.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/CosyVoice/on_boarding.md

The CosyVoice repo has 1.6+k forks, that means that people are interested in playing around with the codebase itself. It is often the case that people just want to adjust slightly the codebase - the diagram give a high-level overview of the project so a person can see where they want to edit (as it is also linked with the source code). I'd love to hear where do you stand on diagram first documentation!

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.

Any feedback is more than welcome!

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.

@aluminumbox
Copy link
Collaborator

hi, what does this .codeboarding do? does it generate some digram automatically?

@ivanmilevtues
Copy link
Author

ivanmilevtues commented Jun 29, 2025

.codeboarding has the generated diagrams (https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/CosyVoice/on_boarding.md)

We also have a free github action which will keep the diagrams up-to-date if you like the diagrams, I'd be more than happy to integrate the action within your github workflows :)

@ivanmilevtues
Copy link
Author

Hey @aluminumbox wanted to quckly update you that we've just released our engine as an open-source repo: https://github.com/CodeBoarding/CodeBoarding

If you are interested on how exactly the whole generation works, you can check it out!

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.

2 participants