Skip to content

[F8-07] Documentación: README, OpenAPI y guía de operaciones #78

Open

Description

@JCCG-code

Fase: F8 · Tamaño: S · Depende de: #65 (F4-10)

Objetivo

Que el proyecto se pueda retomar tras semanas sin tocarlo (desarrollo a tiempo parcial, D-18 en #1).

Alcance

  • README reescrito:

    • Qué es Stories Factory hoy.
    • Arquitectura en un diagrama.
    • Arranque local en 3 comandos con el proveedor fake.
    • Variables de entorno.
    • Cómo añadir un proveedor.

    Se eliminan las referencias a n8n, GCS y Veo como parte de la v1.

  • OpenAPI generado desde los esquemas zod, servido en /api/v1/docs (solo lectura).

  • docs/operations.md:

Criterios de aceptación

  • Siguiendo solo el README, en un clon limpio se genera un vídeo con fake en < 15 min.
  • /api/v1/docs lista todas las rutas de proyectos, credenciales y proveedores.
  • grep -niE "n8n|gcs|google cloud storage" README.md no devuelve nada fuera de la sección de historial.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions