> ## Documentation Index
> Fetch the complete documentation index at: https://maps.solvice.io/llms.txt
> Use this file to discover all available pages before exploring further.

# CLAUDE

# CLAUDE.md

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

## Project Overview

This is the documentation website for Solvice Maps API, built with Mintlify. The project contains API documentation, integration examples, and usage guides for Solvice's routing and mapping services.

## Development Commands

```bash theme={null}
# Install Mintlify CLI globally (required)
npm i -g mintlify

# Run local development server
mintlify dev

# Reinstall dependencies if needed
mintlify install
```

## Project Structure

The documentation is organized by API service:

* `/cube/` - Cube API (matrix routing) documentation
* `/table/` - Table API (distance matrix) documentation
* `/route/` - Route API (directions) documentation
* `/tiles/` - Map tile service documentation
* `/examples/` - Integration examples for Leaflet and MapLibre GL
* `/snippets/` - Reusable documentation components

## Key Files

* `docs.json` - Mintlify configuration defining navigation structure, theme, and API settings
* `openapi.yaml` - OpenAPI 3.0.3 specification for the Solvice Maps Routing API
* MDX files - Documentation content written in Markdown with JSX support

## Architecture Notes

1. **Documentation Framework**: Uses Mintlify which renders MDX files into a modern docs site
2. **API Documentation**: Powered by OpenAPI spec with interactive playground enabled
3. **No Build Process**: Mintlify handles all compilation; no webpack/vite config needed
4. **Navigation Structure**: Two main tabs defined in docs.json - "Routing" and "Tiles"

## Working with Documentation

* All documentation files use MDX format (Markdown + JSX components)
* Images go in `/images/` directory
* API endpoint docs are auto-generated from `openapi.yaml`
* Navigation structure is controlled by the `docs.json` file
* Mintlify hot-reloads changes during development

## Git Workflow

* Main branch is `main`
* The project uses GitHub App for automatic deployment
* Always check for uncommitted changes before starting work