Open dgb opened 5 years ago
I would greatly appreciate more expansive documentation!
The documentation on the github pages is handy, but it lacks a lot of information.
For example, I didn't realize that when using Yt::Video#thumbnail_url
I could specify the quality as an argument. For the past few months I've actually been making a separate call to YouTube to fetch a high-res image. It's great to learn that doing so is unnecessary, but it would have been nice if the documentation elaborated on that without me needing to visit the RDoc pages.
I understand that the RDocs are supposed to be the true/full documentation, but the github-pages reference gives the impression of itself being documentation, and nothing in the info given there implied that there was additional functionality available.
And thanks for maintaining the gem! It's good to see it's still being worked on. Let me know if you need additional contributors.
@YSavir Yeah, we're working on it in fits and starts.
I think my issue with the state of documentation is that it's not clear where to look for what you want. I think a move from RDoc to Github pages was started but not finished. Either way, it'd be nice to have the "reference" documentation up to date and easily accessible, along with "narrative" documentation (sorta like the existing README) that goes through the main use cases.
Anyway, I'll add improving documentation to our list :)
As we get more active in maintaining
yt
, I wanted to share our todo list for this library as a sort of "meta issue". We haven't decided on where we're going to track development, but we can figure that out too 😄as_content_owner
testsyt-support
intoyt
Yt::URL
featuresIf you work on or use this project, let us know what's on your wishlist too.