Repository navigation
docs: README completo (arquitectura, ejecución, decisiones, uso de IA) - #18
Merged
Merged
Conversation
Reescribe README.md siguiendo el criterio de aceptación de la sección 8 de REQUIREMENTS.md: añade el diagrama de arquitectura, instrucciones de ejecución verificadas, decisiones técnicas nuevas (Voyage AI, MongoDB Atlas Vector Search, caché de respuestas ya implementada, rate limiting pendiente, costos), placeholder explícito de GIF y una sección sobre el uso de IA en el desarrollo. Conserva íntegras las notas ya existentes de Autenticación, Documentos y CI. Corrige también RNF-13 y el criterio de aceptación de REQUIREMENTS.md, que afirmaban que un solo `docker compose up` levanta todo el entorno local: el propio docker-compose.yml solo define mongodb/redis/minio/minio-init, sin servicios para las apps. Se documenta explícitamente que son dos comandos (`docker compose up` para infraestructura, `pnpm dev` para las apps), con la decisión registrada en la sección 10, para que REQUIREMENTS.md y README.md cuenten la misma historia. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BoVKssKAe1Z1vGJAEBEzvy
ErgoCodes
marked this pull request as ready for review
September 28, 2026 01:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resumen
Implementa TSK-70: README completo (arquitectura, ejecución, decisiones, GIF y uso de IA), cumpliendo el criterio de aceptación de la sección 8 de
REQUIREMENTS.md.README.mdpor completo: diagrama de arquitectura (Mermaid, tomado deREQUIREMENTS.mdsección 5), instrucciones de ejecución paso a paso verificadas contra el repo real, decisiones técnicas nuevas (Voyage AI, MongoDB Atlas Vector Search, caché de respuestas RNF-09 ya implementada, rate limiting RNF-04 pendiente, costos de las APIs), sección de estado honesta sobre el frontend (placeholder sin flujo funcional todavía), sección de demo con un placeholder explícito de GIF, y una sección sobre el uso de IA en el desarrollo. Conserva íntegras las notas existentes de Autenticación (RF-01), Documentos (RF-02/RF-04) y CI (RNF-12).REQUIREMENTS.md(RNF-13, el criterio de aceptación de la sección 8, y una nueva viñeta en la sección 10): eldocker-compose.ymlreal solo definemongodb/redis/minio/minio-init, no los tres servicios de la app, así que RNF-13 afirmaba algo que el propio compose no cumple. Se documenta explícitamente que son dos comandos —docker compose up(infraestructura) ypnpm dev(apps) — en vez de dar a entender que uno solo basta, yREADME.md/REQUIREMENTS.mdahora cuentan la misma historia.Nota: no se tocó
CLAUDE.md, aunque tiene la misma frase desactualizada ("docker compose up# levanta MongoDB, Redis, MinIO y el resto del entorno local") — ese archivo requiere confirmación explícita del usuario humano antes de editarse, y esa confirmación no llegó en esta sesión. Queda como corrección pendiente, a decidir por separado.Cómo se hizo
La implementación se delegó a la CLI
agy(Google Antigravity, modelo Gemini 3.7 Flash medium) bajo un plan de implementación que fue revisado adversarialmente por Gemini 3.1 Pro antes de escribir código, todo orquestado por Claude Code. El borrador que devolvióagyno se aceptó a ciegas: se verificó contra el código real (versiones depackage.json, estado real de la caché de respuestas y del rate limiting, puerto de Vite, definición del índice vectorial) y se corrigió un error de detalle que traía (las credenciales de ejemplo de la consola de MinIO). También se descubrió y corrigió en el momento queagyhabía escrito su primer intento fuera del worktree aislado, en el checkout principal del repo; ese archivo se restauró a su contenido original antes de continuar.Verificación
pnpm lint,pnpm typecheck,pnpm test,pnpm test:coverage— en verde (100% de cobertura en los archivos de dominio existentes).pnpm --filter @docqa/api test:integrationypnpm --filter @docqa/worker test:integration(con MongoDB arriba) — en verde.README.mdyREQUIREMENTS.mdcuentan la misma historia sobre el alcance dedocker compose up.Pendiente (fuera de este PR)
<!-- TODO: grabar GIF de demo -->enREADME.md.CLAUDE.mdmencionada arriba.Generated with Claude Code
https://claude.ai/code/session_01BoVKssKAe1Z1vGJAEBEzvy