38 results found
-
Documentation Issues and Open Sourcing Twitch offers a very large, widely-used API to a very large developer base, and unfortunately the documentation currently provided is severely lacking, inconsistent and falling behind standards of both accessibility and developer experience.
I know this has been proposed some years ago, but I am going to recreate the voice as I believe I can add some extra points and reasoning.
Issues with Accessibility:
Twitch only offers developers documentation in a fully white (#FFFFFF) background. While this is acceptable for most, this can be extremely difficult to navigate for people with certain eye, neurological and learning conditions. High contrast websites…
33 votes -
Open Source Twitch Documentation Twitch has one of the most intelligent and tech savvy user bases of any product I can think of. If Twitch were to make their documentation source code Open Source, members of the community that are tech savvy enough will do your job for you.
I just went through the documentation when trying to figure out how to make my first banner and my first Video Player Banner. I am unaware of what a "Video Player Banner" as someone that does not normally watch much Twitch but is attempting to start to learn more about it.
As someone that works…
6 votes -
User banned extensions unload So it seems that when a user is banned or timed out, extensions unload/are unavailable to those users.
This is not documented.
It should be documented somewhere
6 votes -
graph syntax not built on deploy The graphs on this page don't look right. The graph syntax is displaying, not the graph itself.
%% Extensions Overview Diagram graph LR Twitch --> | - postMessage - | Extension Extension --> | - postMessage - | Twitch Extension --> | - HTTP - | APIs Extension --> | - HTTP - | EBS[Extension Backend] Identity --> Twitch Chat --> Twitch Memes --> Twitch5 votes -
Publish Official Typescript Typing's for all Data Models It would be very easy to build and design for if there were official typing for all data endpoints. The data between all the different API's for the same data isn't consistent, and with event sub, since it no longer relies on the underlying Helix endpoint, that data can now be different too. This will also mitigate typos on the docs which causes huge headaches when trying to code for API responses and the data not working, or missing fields. The typing can specify which fields are required and which are optional, so when designing your app, you can easily…
5 votes -
Fix misleading example using CLI to test EventSub handler The example for using the CLI to test your handler shows a secret that looks like a 32-byte hexadecimal string. Actually the CLI interprets it as an ASCII string, so the example is actually passing a 64-byte string for the secret. I found this very misleading and it took me a bit of time to figure out why my code was not computing the correct HMAC until I realized that the format the CLI expects is ASCII string not hexadecimal string.
4 votesIs this still occurring? It seems like a bug with the Twitch CLI rather than an issue with the documentation.
-
Add keyboard shortcut for docs search A lot of dev docs sites have a shortcut like ctrl+k or / for focusing the search box. It'd be nice if this was implemented
3 votes -
Add a copy link icon to each section header Since the docs are so long, and each header has an ID you can link to, you should put a link icon that copies the link to clipboard for each header for easy sharing.
3 votes -
Split the Helix API reference into sub-categories As the Helix API reference page (https://dev.twitch.tv/docs/api/reference) is continuing to grow it it is starting to become unwieldly with the number of entries.
It would be beneficial to the docs to create sections for different areas of the API. Appropriate names for the sections are already listed in the API, as at the top of the reference page is a table that has a 'Resource' column which would be perfect for this usage, and that table can remain at the root reference page so that devs can see at a glance what endpoints are in what section, then…
3 votesThis has been on the roadmap, and is planned for early 2021.
-
"Build your first Extension" section lacks critical information The "build your first extension" walkthrough was perfect until about the half-way mark, then it started omitting hugely important steps. I had to stumble around to try and keep up, and although I was modestly successful, I was not able to see my Panel extension in my channel. Would have been helpful to actually have a zip file of assets to upload, because I have no idea whether I did that step correctly.
3 votes -
Fixed position or better visibility for important announcements As per a request from Barry, it would helpful if any flagged messages on a page were fixed or visible when loading a bookmarked section. For example, right now there is an important message on the API reference page about OAuth requirements for Helix, but if someone goes directly to https://dev.twitch.tv/docs/api/reference#get-streams, they will not see this message currently.
3 votes -
Document error responses https://dev.twitch.tv/docs/authentication/getting-tokens-oauth#oauth-client-credentials-flow
There's no information about error response and it doesn't seem to be fully compatible with RFC 6749 which means I can't find info about possible errors easily.
3 votes -
Information about config service unclear From: https://github.com/twitchdev/issues/issues/55
Brief description
https://dev.twitch.tv/docs/extensions/building#using-the-configuration-service
Doesn't mention the key bit of information regarding the size limit of 5kb
Additional context or questions
It's important to note here as people will start designing an extension and then discover the sizing limit late into construction of an extension. For clarity the limit should be noted here also
3 votes -
Unity C# Examples and Chat Message Event Example I really wish there were examples using the Unity C# Plugin for some of the JS coding in here.
It's difficult to figure out how to read chat messages with the Unity plugin, so an example showing how to subscribe to a chat event would be helpful since I want to trigger stuff with messages from chat.
2 votes -
[Typo] channel.suspicious_user.update event type definition https://dev.twitch.tv/docs/eventsub/eventsub-reference/#channel-suspicious-user-update-event
data structure unclear. indentation doesn't match parent types
2 votes -
Miscategorized `preferred_username` claim Hello, the
preferred_usernameclaim is marked as non-default whereas it appears to me that it's always included as part of the default user info retrieved.2 votes -
unity documentation examples do not work or they are wrong the oauth sample does not works and it has many mistakes, i was able to go trough them.
subscribe to events functions like "SubscribeToFollowEvent()" does not exist at all, its the same for every example
2 votes -
suggestion I hope you can provide a Node.js example of a WebSocket connection to the server at 'wss://eventsub.wss.twitch.tv/ws'. After reading the document, I am still unable to establish a normal WebSocket connection to the Twitch EventSub server. Thank you.
2 votes -
Unity code has lots of errors The first chunk of code has lots of errors. Simple things like using lower case s on 'void Start' etc
2 votes -
Fix capitalization the codeblock under 'Authentication' has quite a few issues with it.
Incorrect capitalization on the TwitchSDK.Interop; , a missing semicolon on the first variable declaration, incorrect capitalization on the Start() and UpdateAuthState()2 votes
- Don't see your idea?