Good API documentation should help developers understand a project, make their first request, and figure out what to do when something goes wrong.

Thally is a platform for building and managing developer documentation. In this tutorial, I'll show how I used it to document TaskSocial, a task management API, from setting up the documentation site to configuring navigation, connecting an OpenAPI specification, and publishing the result.

While testing the documentation, I also found a difference between a successful authenticated request with curl and a failed request in the API playground. I'll explain what I tested and what I learned from it.

The published TaskSocial documentation site, organised around getting started, practical guides, and the API reference.

1.…