flurix-developer/wiki/00-index.md

Generador de documentación desde comentarios en JS/TS/PY usando Python

# Índice de Documentación

## Documentación General

- [Visión General del Proyecto](01-project-overview.md)
  - Descripción del proyecto
  - Arquitectura técnica
  - Componentes principales
  - Integraciones

- [Guía para Desarrolladores](02-developer-guide.md)
  - Estructura del código
  - Componentes principales
  - Flujo de trabajo
  - Convenciones de código
  - Guía de contribución

- [Guía de Paquetes NPM](03-npm-package-guide.md)
  - Creación de paquetes
  - Pruebas y desarrollo
  - Publicación y mantenimiento
  - Buenas prácticas

## Estructura de la Documentación

```mermaid
graph TD
    A[Índice] --> B[Visión General]
    A --> C[Guía para Desarrolladores]
    A --> D[Guía NPM]
    B --> E[Arquitectura]
    B --> F[Componentes]
    C --> G[Estructura del Código]
    C --> H[Convenciones]
    D --> I[Creación]
    D --> J[Publicación]
```

## Navegación Rápida

### Para Nuevos Desarrolladores
1. Comienza con la [Visión General del Proyecto](01-project-overview.md)
2. Revisa la [Guía para Desarrolladores](02-developer-guide.md)
3. Familiarízate con la estructura del código
4. Sigue las convenciones establecidas

### Para Contribuidores
1. Revisa las convenciones de código
2. Sigue el proceso de desarrollo
3. Asegúrate de documentar los cambios
4. Prueba tus modificaciones

### Para Usuarios
1. Consulta la [Visión General](01-project-overview.md) para entender el propósito
2. Revisa los requisitos técnicos
3. Sigue las instrucciones de instalación
4. Utiliza los comandos disponibles

### Para Creadores de Paquetes
1. Consulta la [Guía de Paquetes NPM](03-npm-package-guide.md)
2. Sigue el proceso de creación y publicación
3. Implementa las pruebas necesarias
4. Mantén tu paquete actualizado

## Mantenimiento de la Documentación

La documentación se mantiene en la carpeta `wiki/` y se organiza de la siguiente manera:

- `00-index.md`: Este archivo, índice principal
- `01-project-overview.md`: Visión general del proyecto
- `02-developer-guide.md`: Guía para desarrolladores
- `03-npm-package-guide.md`: Guía para crear y publicar paquetes npm

Para actualizar la documentación:

1. Modifica los archivos correspondientes en la carpeta `wiki/`
2. Actualiza este índice si es necesario
3. Asegúrate de que los enlaces sigan funcionando
4. Mantén la consistencia en el formato

## Convenciones de Documentación

- Usar Markdown para todo el contenido
- Incluir diagramas Mermaid cuando sea apropiado
- Mantener una estructura jerárquica clara
- Usar enlaces relativos para la navegación
- Mantener la documentación actualizada con el código