Skip to content

Update README.md with link to live diagram #3580

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: master
Choose a base branch
from

Conversation

JetsettingJames
Copy link

Adding badge with link to https://repomapr.com/th-ch/youtube-music to help devs understand the repo.
image

@ArjixWasTaken
Copy link
Contributor

ArjixWasTaken commented Jul 8, 2025

As a contributor to this project, I can confidently say that it is highly inaccurate (e.g. it says we use React when we use Solidjs), and honestly it's way more confusing than just reading the README and browsing the code.

Also, the "node"s themselves are defined in what appears to be random classification/order.
It also claims that "youtube-dl" is used in this project, which is blatanly wrong.

@JetsettingJames
Copy link
Author

@ArjixWasTaken thanks for your constructive feedback. If improved, would you see utility in this product?

@ArjixWasTaken
Copy link
Contributor

Personally? No
I have aphantasia, among other stuff, so I find it easier to just look at the code.

Would be interesting if it generated documentation, akin to readthedocs and had a node-based explorer, where each node is an entry in the documentation.

But the accuracy of the data is important as well.

@ArjixWasTaken
Copy link
Contributor

ArjixWasTaken commented Jul 8, 2025

Overall, th-ch/youtube-music is not a library, so AI generated documentation like this seems out of place.
Maybe if it could focus on specific parts (just like you would do on hand-written docs), and not the entire codebase, it would be better.

@JetsettingJames
Copy link
Author

@ArjixWasTaken Thanks. Have indexed accurately other proper libraries, so maybe that. Will iterate and ping once we feel we have something better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants