The Challenge: The "PDF Problem"
Xtrap API had a great product but terrible documentation—a 50-page PDF that was outdated the moment it was exported. Developers complained it was hard to search, leading to a flood of basic support tickets.
The Strategy
We treated the documentation as a product itself, building it with Next.js (Static Site Generation) for instant page loads and SEO benefits.
1. Docs as Code (MDX)
By writing docs in MDX (Markdown + JSX), the engineering team could update documentation in the same commit as their code changes. No more stale PDFs.
2. Instant Search
We integrated Algolia DocSearch. Developers could now find the specific endpoint they needed in milliseconds, jumping straight to the code example.
The Execution
// Dynamic Code Block Component
curl -X POST https://api.xtrap.com/v1/data \
-H "Authorization: Bearer "
Interactive code snippets with "Copy to Clipboard" functionality reduced friction for developers trying to make their first API call.
The Results
Support tickets related to "How do I...?" dropped by 60%. The "Time to First Hello World" (a key metric for API products) decreased from 2 hours to 15 minutes.
Documentation defines adoption.
Don't let bad docs kill your great product. Let's build a portal.
Improve Developer Experience