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

# Claude Code Instructions

> Guía de trabajo para Claude Code en el repo de documentación Opptima

# Instrucciones para Claude Code — Documentación Opptima

Este repo contiene la documentación oficial de **Opptima**, construida con [Mintlify](https://mintlify.com). Se publica automáticamente en [docs.opptima.com](https://docs.opptima.com) al hacer push a `main`.

***

## Contexto del proyecto

* **Plataforma**: Mintlify (plan Hobby)
* **Dominio**: `docs.opptima.com`
* **Repo**: `webmasterpanda/mintlify-doc-opptima`
* **Rama de producción**: `main` (auto-deploy)
* **Idioma del contenido**: Español

***

## Estructura del repo

```text theme={null}
.
├── docs.json              # Config global (navegación, tema, colores, dominio)
├── index.mdx              # Página de inicio
├── quickstart.mdx         # Guía de inicio rápido
├── development.mdx        # Setup local
├── api-reference/
│   └── introduction.mdx   # Intro a la API
├── logo/                  # Logos (light.svg, dark.svg)
└── favicon.svg
```

***

## Reglas obligatorias al editar

### 1. Toda página nueva debe registrarse en `docs.json`

Agrégala en `navigation.tabs[].groups[].pages`. Si no, **no aparece en el sidebar**.

```json theme={null}
{
  "group": "Empezar",
  "pages": ["index", "quickstart", "development", "nueva-pagina"]
}
```

> ⚠️ El path **NO** lleva extensión `.mdx`.

### 2. Frontmatter obligatorio en cada `.mdx`

```mdx theme={null}
---
title: "Título de la página"
description: "Descripción corta para SEO y búsqueda"
icon: "rocket"
---
```

### 3. Idioma: español

Todo el contenido visible al usuario debe estar en español neutro.

### 4. Valida antes de commitear

```bash theme={null}
mint broken-links   # detecta enlaces rotos
mint dev            # previsualiza en http://localhost:3000
```

***

## Componentes Mintlify disponibles

| Componente                                          | Uso                                                      |
| --------------------------------------------------- | -------------------------------------------------------- |
| `<Card>` / `<CardGroup>`                            | Tarjetas de navegación destacadas                        |
| `<Steps>` / `<Step>`                                | Guías paso a paso                                        |
| `<Tabs>` / `<Tab>`                                  | Contenido alternativo (multi-lenguaje, multi-plataforma) |
| `<CodeGroup>`                                       | Varios snippets de código en pestañas                    |
| `<Accordion>` / `<AccordionGroup>`                  | FAQs y contenido colapsable                              |
| `<Note>`, `<Warning>`, `<Tip>`, `<Info>`, `<Check>` | Callouts contextuales                                    |
| `<ParamField>` / `<ResponseField>`                  | Parámetros y respuestas de API                           |
| `<Frame>`                                           | Wrapper para imágenes con estilo                         |

Referencia completa: [https://mintlify.com/docs/components](https://mintlify.com/docs/components)

***

## Flujo de trabajo recomendado

```bash theme={null}
# 1. Nueva rama
git checkout -b feat/nombre-descriptivo

# 2. Edita con Claude Code
#    - Crea/modifica .mdx
#    - Registra páginas nuevas en docs.json

# 3. Previsualiza
mint dev

# 4. Valida
mint broken-links

# 5. Commit y push
git add .
git commit -m "docs: descripción del cambio"
git push origin feat/nombre-descriptivo

# 6. Abre PR → merge a main → deploy automático
```

***

## Convenciones de commits

Usa prefijos tipo Conventional Commits:

* `docs:` — cambios de contenido
* `feat:` — nueva página o sección
* `fix:` — corrección de errores/typos/enlaces
* `style:` — formato, sin cambio de contenido
* `chore:` — config, dependencias, assets

***

## Cosas que NO debes hacer

* ❌ No edites `docs.json` rompiendo el schema JSON (valida con `mint dev`).
* ❌ No referencies páginas inexistentes en `pages`.
* ❌ No pushees directo a `main` sin previsualizar.
* ❌ No uses HTML crudo si existe un componente Mintlify equivalente.
* ❌ No incluyas claves o secretos en ejemplos de código (usa `YOUR_API_KEY`).

***

## Referencias oficiales

* Docs Mintlify: [https://mintlify.com/docs](https://mintlify.com/docs)
* Componentes: [https://mintlify.com/docs/components](https://mintlify.com/docs/components)
* Schema `docs.json`: [https://mintlify.com/docs/settings](https://mintlify.com/docs/settings)
* CLI: [https://mintlify.com/docs/installation](https://mintlify.com/docs/installation)
* Markdown extendido: [https://mintlify.com/docs/text](https://mintlify.com/docs/text)

***

## Plantilla rápida para nueva página

```mdx theme={null}
---
title: "Título"
description: "Descripción corta"
icon: "icono-fontawesome"
---

## Sección principal

Contenido introductorio.

<Steps>
  <Step title="Primer paso">
    Detalle del paso.
  </Step>
  <Step title="Segundo paso">
    Detalle del paso.
  </Step>
</Steps>

<Note>
  Recuerda registrar esta página en `docs.json`.
</Note>
```