Unifying API Docs and Dev Communication

Discussions General
1

It appears there are currently multiple, overlapping places developers need to monitor to understand the API, ask questions, and track changes:

API documentation

  1. https://trakt.docs.apiary.io
  2. https://docs.trakt.tv

Developer communication and support

  1. Github Issues: Trakt API
  2. Github Discussions: Trakt API
  3. https://forums.trakt.tv/

In practice, this makes it difficult to determine what has changed, what is changing, and where to ask questions, without monitoring all of these sources and piecing together information from forum posts, GitHub issues, and doc websites.

I wasn’t aware of this forum until yesterday, when a production integration unexpectedly broke and web searches led me to a Reddit post referencing a staff announcement here about an upcoming change.

Would it be possible to consolidate this into fewer, clearly defined channels?

Specifically:

  • A single, authoritative location for API documentation

  • A single, authoritative changelog for breaking changes, including effective dates and versions

  • Optional broadcast communication (e.g., developer email notifications) for impactful API changes

This would reduce ambiguity around where to look for information and help prevent production breakage caused by fragmented communication.

3 Likes