Skip to content
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

Maintenance Reboot #351

Open
2 of 10 tasks
dgb opened this issue Jun 19, 2019 · 2 comments
Open
2 of 10 tasks

Maintenance Reboot #351

dgb opened this issue Jun 19, 2019 · 2 comments

Comments

@dgb
Copy link
Contributor

dgb commented Jun 19, 2019

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 😄

  • Add a PR template
  • Decide on where to track issues
  • Make issues for future hopes and dreams ✨
  • Make fixture script for setting up a YouTube account
  • Change tests to use fixtures
    • or have integration tests be runnable with VCR? and then run them without cassettes when we hit master?
  • Re-enable as_content_owner tests
  • Fold yt-support into yt
  • Re-enable Yt::URL features
  • Remove hard ActiveSupport dependency
    • this is necessary for instrumentation, but anything else?
  • Improve documentation and visibility of docs.

If you work on or use this project, let us know what's on your wishlist too.

@YSavir
Copy link

YSavir commented Aug 9, 2019

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.

@dgb
Copy link
Contributor Author

dgb commented Oct 10, 2019

@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 :)

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

No branches or pull requests

2 participants