Skip to main content

​
CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

​
Project Overview

Sevalla API documentation site built with Mintlify. All API endpoint pages are auto-generated from remote OpenAPI specs — no local MDX files per endpoint.

​
Architecture

  • Remote OpenAPI specs (source of truth for all endpoint details, schemas, and examples):
    • https://api-dev.sevalla.com/v3/openapi.json — v3 primary endpoints
    • https://api-dev.sevalla.com/v2/openapi.json — v2 legacy endpoints
  • docs.json — Mintlify configuration (navigation tabs, theme, integrations, navbar, footer); each tab has an openapi field pointing to a remote spec, and Mintlify auto-generates all endpoint pages
  • index.mdx — Standalone landing page

​
Development

There is no build step or package.json. Mintlify handles rendering and hosting. To preview locally, install the Mintlify CLI and run: 
npx mintlify dev

​
Adding a New Endpoint

  1. Add the endpoint definition to the appropriate remote OpenAPI spec (v2 or v3)
  2. Mintlify auto-generates the page — no MDX file or navigation entry needed

​
Conventions

  • All API endpoints use Bearer token authentication
  • Navigation uses two tabs (v3 and v2) with a top-left switcher
  • Commit messages follow conventional commits: feat(scope): description
  • Never use em dashes (—) in any content. Use periods, commas, or rephrase instead
  • Write copy that sounds human and direct. Avoid generic AI-sounding filler phrases
  • Always use TypeScript for code examples, never Python or other languages