What problem does it solve?
Manually creating and maintaining detailed API documentation is a time-consuming and often inconsistent process, leading to outdated or incomplete references for developers. This skill automates the generation and maintenance of high-quality REST API documentation using Fumadocs.
Core Features & Use Cases
- Structured Documentation: Creates organized API reference pages for endpoints, authentication, request/response schemas, and webhooks.
- Multi-Language Examples: Provides code examples in cURL, JavaScript, and Python for easy integration.
- Consistent Formatting: Ensures all documentation follows a clear, precise, and example-driven style with tables for parameters and responses.
- Use Case: When you've implemented a new
/challenges API endpoint, use this skill to generate its documentation. It will create an MDX file with sections for endpoint details, authentication, path/request parameters, example requests in multiple languages, and success/error responses, ensuring developers have a complete and accurate reference.
Quick Start
Document the new POST /v1/workspaces/{workspaceId}/challenges endpoint. Include request body fields, example requests in cURL and JavaScript, and success/error responses.
