Introducing a new docs experience
We’ve refreshed the developer documentation and API reference experience to help you find the guides and materials needed to rapidly deliver apps to your users and the Twitch community. This release is an early step toward delivering a developer experience that inspires and delights you to create with our products.
Rather than myself talking about it, check it out at dev.twitch.tv/docs.
We strive to create a docs experience that responds to customer feedback and incorporates idioms common to best-in-class documentation apps. Here are some highlights from this release:
Search: Yes! You can search across all of our documentation, and we’ll match by title, content, or API references.
Sticky navigation: As you browse content, you’ll know exactly where you are in the document with a helpful indicator. Having the navigation accessible at all times should make it easier to hop back and forth, and get what you need.
Three-column reference browsing: We’ve pulled out sample request and and response returns for every API method (including V5), making it easy to try our capabilities as you build iteratively for your users. Here’s an example which documents the method to GET users.
Mobile-friendly: Open docs on an iPad, phone, or other device in case you need a quick reference in a smaller viewport.
In future releases, we hope to make it easier to get to “Hello, World!” and success with our products. Be on the lookout for more in the coming months.
We’re happy to hear any feedback on our docs, website, or products in general. Start a discussion on our forums or mention us on Twitter.