Tarea: Crear una Nueva Guía de Usuario para la Configuración y el Uso Básico

Descripción

Crear una guía de usuario fundamental en docs/guides/ que sirva como el documento principal para que un nuevo usuario configure y comience a usar aclarai. Esta guía debe cubrir la configuración del entorno, la ejecución de la pila de Docker Compose, y los pasos iniciales para importar contenido, asegurando que un usuario pueda pasar de una instalación limpia a un sistema funcional.

Alcance

Incluido

• Creación del Fichero:
  • Crear un nuevo fichero Markdown: docs/guides/configuration_guide.md.
• Contenido de la Guía:
  • Sección de Configuración del Entorno:
    • Instrucciones claras sobre cómo copiar .env.example a .env y la importancia de configurar las contraseñas de la base de datos (POSTGRES_PASSWORD, NEO4J_PASSWORD).
    • Una explicación de la jerarquía de configuración (defaults, settings/aclarai.config.yaml, variables de entorno).
    • Instrucciones sobre cómo restaurar la configuración a los valores por defecto.
  • Sección de Uso de Docker Compose:
    • Comandos básicos para iniciar, detener y ver los logs de la pila completa (make up, make down, make logs).
    • Instrucciones sobre cómo acceder a las interfaces de usuario de los servicios (Neo4j Browser, RabbitMQ Management).
  • Sección de Primeros Pasos:
    • Una guía sobre cómo añadir ficheros Markdown al directorio vault/ para que sean procesados.
    • Un ejemplo simple de cómo usar el "Import Panel" en la UI de Gradio para importar el primer fichero de conversación.
  • Sección de Configuración de la UI:
    • Una descripción de alto nivel de las secciones del "Configuration Panel" (Modelos, Umbrales, etc.), explicando su propósito general.

Excluido

• Tutoriales detallados sobre funcionalidades específicas como la creación de conceptos o el pipeline de Claimify. (Estos tendrán sus propias guías).
• Documentación de la API para desarrolladores.
• Guías avanzadas de troubleshooting o de optimización de rendimiento.
• La creación del contenido del vídeo o podcast mencionados en la tarea del README.md.

Criterios de Aceptación

• El nuevo fichero docs/guides/configuration_guide.md existe y está poblado con el contenido descrito en el alcance.
• La guía proporciona instrucciones claras y suficientes para que un nuevo usuario pueda configurar las variables de entorno necesarias y levantar la pila de Docker Compose.
• La guía explica cómo añadir ficheros al vault y cómo realizar una importación básica a través de la UI.
• La guía describe las principales secciones del panel de configuración de la UI y su propósito general.

Dependencias (estas son particularmente las cosas en este EPIC que necesitan ser hechas)

• Tarea: Actualizar el README.md Raíz: La guía de usuario puede ser enlazada desde el README.md principal, sirviendo como el siguiente paso lógico para un nuevo usuario después de leer la introducción.

Entregables

• Nuevo fichero: docs/guides/configuration_guide.md.

Estimación de Esfuerzo (en días)

• 2 días

Riesgos y Mitigaciones

• Riesgo: Las instrucciones podrían volverse obsoletas si la estructura de configuración o los comandos de Docker cambian significativamente.
  • Mitigación: La guía se centrará en los flujos de trabajo fundamentales que son menos propensos a cambiar. Se establecerá como una práctica del equipo revisar y actualizar las guías de usuario al final de cada epic que introduzca cambios en la configuración o en el proceso de arranque.
• Riesgo: La guía podría ser demasiado técnica para un usuario no desarrollador.
  • Mitigación: El contenido se escribirá con un enfoque en el "cómo hacer" en lugar del "por qué funciona así", utilizando comandos de make de alto nivel siempre que sea posible y evitando jerga interna. Se incluirán capturas de pantalla o GIFs si es necesario para clarificar los pasos en la UI.