This repository contains a documentation prototype built with Mintlify, based on OpenWeather's Current Weather Data API.
🔗 Live documentation: https://arnaud.mintlify.app/introduction
🔗 Portfolio case study: https://arnaudhervy.com/portfolio/api-docs/
This project demonstrates how raw API documentation can be transformed into a clear, task-oriented developer experience.
It focuses on:
- API onboarding (first successful request)
- Documentation structure and navigation
- Response handling and edge cases
- Practical developer workflows
- Getting started guide (first API call)
- Guides (authentication, rate limits, response behavior)
- API reference (OpenAPI-based)
- Mintlify: documentation framework
- MDX: content authoring
- OpenAPI: API schema and reference generation
This is a portfolio project showcasing how to design developer-friendly API documentation, with an emphasis on clarity, usability, and real-world integration concerns.