EN

Convenciones de documentación

Front matter

Cada página HTML debe comenzar con front matter YAML. Usa la siguiente plantilla y ajusta los valores según sea necesario:

---
layout: default
title: "Título de la página"
description: "Resumen corto de la página"
nav_order: 10
---

Encabezados

• Usa un único <h1> que coincida con el título de la página.
• Estructura el contenido con <h2> para secciones y <h3> para subsecciones.
• No saltes niveles de encabezado.

Referenciando el README

• Evita duplicar explicaciones largas que ya existen en README.md.
• Cuando el contenido original permanezca en el README, enlaza usando rutas relativas, por ejemplo Instalación.
• Pueden incluirse resúmenes cuando sean útiles, pero mantiene el README como la fuente canónica para instrucciones completas.

Enlaces

• Usa enlaces relativos con extensiones explícitas, por ejemplo Quick API.
• Prefiere ./ para el mismo directorio y ../ para directorios padre.
• Verifica enlaces antes de confirmar usando un comprobador como lychee: lychee docs/**/*.html.

Lista de migración

Destacados

• [ ] Crear docs/highlights.html.
• [ ] Añadir front matter y un único H1.
• [ ] Resumir beneficios clave en viñetas y enlazar a las páginas de predictores y Quick API.

Instalación

• [x] Crear installation.html.
• [x] Detallar instrucciones completas de instalación incluyendo aceleración opcional numba.
• [x] Referenciar requisitos desde el README para evitar divergencias.

Reproducibilidad

• [ ] Crear docs/reproducibility.html.
• [ ] Documentar sistema operativo, hardware, versión de Python y pasos para recrear el entorno.

API rápida

• [ ] Crear docs/quick_api.html.
• [ ] Listar objetos públicos con breves descripciones.

Tabla de métodos

• [ ] Crear docs/method_matrix.html.
• [ ] Traducir tabla de métodos implementados para cada objeto.

Experimentos y benchmarks

• [x] Crear experiments_benchmarks.html.
• [x] Resumir scripts disponibles y enlazar resultados en benchmark/.

Parámetros clave

• [ ] Crear docs/key_parameters.html.
• [ ] Describir hiperparámetros ajustables y sus efectos.

Consejos de rendimiento

• [ ] Crear docs/performance_tips.html.
• [ ] Proporcionar orientación para acelerar cálculos y escalar a altas dimensiones.

Limitaciones

• [x] Crear docs/limitations.html.
• [x] Aclarar restricciones algorítmicas y prácticas.

Imágenes

• [ ] Crear docs/images.html.
• [ ] Explicar la omisión de activos binarios y referenciar repositorios externos si es necesario.