flurix-developer/wiki/01-project-overview.md

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

# Flurix Developer - Documentación del Proyecto

## Descripción General

Flurix Developer es una herramienta de documentación automatizada diseñada para extraer y generar documentación a partir de comentarios JSDoc en archivos JavaScript, TypeScript, JSX y TSX. Esta herramienta utiliza un script en Python para procesar los archivos y generar documentación en formato Markdown.

## Objetivo

El objetivo principal de Flurix Developer es simplificar y automatizar el proceso de documentación de código, asegurando que la documentación esté siempre sincronizada con el código fuente y siga un formato consistente.

## Arquitectura Técnica

### Componentes Principales

```mermaid
graph TD
    A[Flurix Developer] --> B[Script Python]
    B --> C[Extractor de JSDoc]
    B --> D[Generador Markdown]
    C --> E[Procesamiento de Archivos]
    D --> F[Documentación Final]
    
    subgraph "Proceso de Documentación"
        E --> G[Archivos JS/TS/JSX/TSX]
        G --> H[Extracción de Comentarios]
        H --> I[Generación de MD]
    end
```

### Tecnologías Utilizadas

- **Node.js**: Plataforma de ejecución para el paquete npm
- **Python 3.x**: Lenguaje utilizado para el script de procesamiento
- **Markdown**: Formato de salida para la documentación
- **JSDoc**: Estándar de documentación para JavaScript/TypeScript

### Flujo de Trabajo

1. El usuario instala el paquete mediante npm
2. El script Python se ejecuta sobre los archivos fuente
3. Se extraen los comentarios JSDoc
4. Se genera la documentación en formato Markdown
5. Los archivos se organizan en una estructura de directorios

## Integraciones

El proyecto está diseñado para integrarse con:

- **Sistemas de Control de Versiones**: Compatible con Git y otros sistemas
- **Herramientas de CI/CD**: Puede ser ejecutado como parte del proceso de construcción
- **Editores de Código**: Compatible con cualquier editor que soporte JSDoc

## Estructura del Proyecto

```mermaid
graph LR
    A[flurix-developer] --> B[scripts/]
    A --> C[package.json]
    A --> D[README.md]
    B --> E[generate_docs.py]
    
    subgraph "Documentación Generada"
        F[docs/] --> G[Archivos .md]
    end
```

## Características Principales

1. **Extracción Automática**: Procesa automáticamente archivos JS/TS/JSX/TSX
2. **Formato Consistente**: Genera documentación en formato Markdown estandarizado
3. **Estructura Jerárquica**: Mantiene la estructura de directorios del código fuente
4. **Integración con npm**: Fácil instalación y uso a través de npm
5. **Personalización**: Permite configurar directorios de entrada y salida

## Requisitos Técnicos

- Node.js y npm instalados
- Python 3.x
- pip (gestor de paquetes de Python)
- Permisos de escritura en el directorio de destino

## Limitaciones Actuales

- Solo procesa archivos JavaScript, TypeScript, JSX y TSX
- Requiere comentarios JSDoc para generar documentación significativa
- No soporta documentación en tiempo real