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

Documentation issues #12

Open
tedyoung opened this issue Apr 15, 2019 · 2 comments
Open

Documentation issues #12

tedyoung opened this issue Apr 15, 2019 · 2 comments
Labels
bug help wanted website Issue is related to website

Comments

@tedyoung
Copy link

I'd like to help improve the docs (at least), so if you're interested in Doc PRs, let me know.


The documentation is confusing in a number of areas, especially when it reads like text has been copied-and-pasted from Twitch's docs. For example, from the Twitch Chat page:

Twitch Chat (WebSocket)

Twitch offers an IRC interface to our chat functionality. This allows you to, for instance:

Develop bots for your channel.
Connect to a channel’s chat with an IRC client instead of using the Web interface.

While our IRC server generally follows RFC1459, there are several cases where it behaves slightly differently than other IRC servers; as described below, there are many Twitch-specific IRC capabilities

This made no sense to me when I was just starting out, so perhaps writing it in terms of the user of this library would be useful?


The "Standalone" vs. "Use as part of Twitch4J" is also confusing. Why would I want to do one or the other?


Finally, the OAuth Token requirement was very confusing and for hours I struggled trying to get the Chat API to work, only to find out that I had the wrong type of OAuth Token. Making it clear which token is needed, and more strongly suggesting to use the https://twitchtokengenerator.com/ site would have saved me lots of frustration.

@PhilippHeuer
Copy link
Member

Thats true, i copied sections of the twitch docs partially for the introduction of the modules - i didn't catch that wording then ;)
PR's to improve the docs are more than welcome. /docs/content

All 3 points you made are valid and should be improved as it helps new users getting started easier. Thanks for opening the issue.

@iProdigy iProdigy transferred this issue from twitch4j/twitch4j Jun 2, 2021
@stachu540 stachu540 added bug help wanted website Issue is related to website labels Jun 25, 2021
@eltmon

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug help wanted website Issue is related to website
Projects
None yet
Development

No branches or pull requests

4 participants