diff --git a/docs/acta-constitucion.md b/docs/acta-constitucion.md index 8368611..e08f30e 100644 --- a/docs/acta-constitucion.md +++ b/docs/acta-constitucion.md @@ -2,6 +2,10 @@ --- +## Relacionado + +- **[Introducción](introduccion.md)** + ## Propósito Crear una plataforma web que permita a fotógrafos profesionales almacenar, distribuir y colaborar con sus clientes en la gestión de imágenes digitales de manera eficiente y segura. diff --git a/docs/analisis-tecnico.md b/docs/analisis-tecnico.md index eba20df..0590014 100644 --- a/docs/analisis-tecnico.md +++ b/docs/analisis-tecnico.md @@ -1,5 +1,12 @@ # Galerías Fotográficas - Análisis técnico +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Decisiones de arquitectura](decisiones-arquitectura.md)** +- **[Documentación de la API](documentacion-api.md)** + ## Arquitectura del sistema Queremos hacer un sistema modular, con componentes independientes que se puedan desarrollar, probar e implementar de forma aislada. diff --git a/docs/casos-uso.md b/docs/casos-uso.md index 60f8ba3..7950d21 100644 --- a/docs/casos-uso.md +++ b/docs/casos-uso.md @@ -1,5 +1,12 @@ # Galerías Fotográficas - Casos de Uso +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Análisis técnico](analisis-tecnico.md)** +- **[Requisitos funcionales](requisitos-funcionales.md)** + ## Caso de uso 1: Administrador da de alta un nuevo profesional 1. El administrador accede al sistema. diff --git a/docs/decisiones-arquitectura.md b/docs/decisiones-arquitectura.md index 22be379..ea209ba 100644 --- a/docs/decisiones-arquitectura.md +++ b/docs/decisiones-arquitectura.md @@ -1,5 +1,12 @@ # Galerías Fotográficas - Decisiones de Arquitectura +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Análisis técnico](analisis-tecnico.md)** +- **[Requisitos funcionales](requisitos-funcionales.md)** + ## ¿Por qué Angular en lugar de React? Como producto final, se pretende vender varias plantillas frontales. diff --git a/docs/documentacion-api.md b/docs/documentacion-api.md index f48499d..a741b97 100644 --- a/docs/documentacion-api.md +++ b/docs/documentacion-api.md @@ -1,5 +1,12 @@ # Galerías Fotográficas - Documentación API +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Decisiones de arquitectura](decisiones-arquitectura.md)** +- **[Análisis técnico](analisis-tecnico.md)** + ## Autenticación y autorización POST `/auth/login` -> Inicia sesión y devuelve un token de autenticación. diff --git a/docs/guia-estilo.md b/docs/guia-estilo-uiux.md similarity index 96% rename from docs/guia-estilo.md rename to docs/guia-estilo-uiux.md index b1f68cb..9d5bac5 100644 --- a/docs/guia-estilo.md +++ b/docs/guia-estilo-uiux.md @@ -1,4 +1,10 @@ -# Galerías Fotográficas - Guía de Estilo +# Galerías Fotográficas - Guía de Estilo UI/UX + +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Requisitos funcionales](requisitos-funcionales.md)** ## Materiales diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..921c130 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,29 @@ +# Índice del Proyecto + +## Descripción del Proyecto + +Este proyecto, **Galerías Fotográficas**, proporciona una plataforma para organizar, visualizar y gestionar colecciones de fotografías. Incluye documentación sobre la finalidad del proyecto, instrucciones detalladas para la instalación y configuración, ejemplos de uso, una sección de preguntas frecuentes y canales de contacto para soporte. El objetivo es facilitar la creación y administración de galerías fotográficas de manera sencilla y eficiente. + +## Contenido + +- **[Acta de constitución](docs/acta-constitucion.md)** + +- **[Análisis técnico](docs/analisis-tecnico.md)** + +- **[Casos de uso](docs/casos-uso.md)** + +- **[Decisiones de arquitectura](docs/decisiones-arquitectura.md)** + +- **[Documentación de la API](docs/documentacion-api.md)** + +- **[Guía de estilo](docs/guia-estilo.md)** + +- **[Introducción](docs/introduccion.md)** + +- **[Manual de usuario](docs/manual-usuario.md)** + +- **[Plan de desarrollo](docs/plan-desarrollo.md)** + +- **[Plan de pruebas](docs/plan-testing.md)** + +- **[Requisitos funcionales](docs/requisitos-funcionales.md)** diff --git a/docs/introduccion.md b/docs/introduccion.md index abc6f6c..2e7aa8f 100644 --- a/docs/introduccion.md +++ b/docs/introduccion.md @@ -2,6 +2,10 @@ --- +## Relacionado + +- **[Acta de constitución](acta-constitucion.md)** + ## Que problema identificamos Existen multiples alternativas para la distribución de imágenes digitales, como redes sociales o proveedores de almacenamiento en la nube. diff --git a/docs/manual-usuario.md b/docs/manual-usuario.md index 5907dc8..9c2101c 100644 --- a/docs/manual-usuario.md +++ b/docs/manual-usuario.md @@ -6,4 +6,11 @@ Guía para clientes FAQ y resolución de problemas -Videos tutoriales (cuando aplique) --> \ No newline at end of file +Videos tutoriales (cuando aplique) --> + +# Galerías Fotográficas - Guía de Usuario + +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** diff --git a/docs/plan-desarrollo.md b/docs/plan-desarrollo.md index e4195cd..bf212da 100644 --- a/docs/plan-desarrollo.md +++ b/docs/plan-desarrollo.md @@ -1,5 +1,12 @@ # Galerías Fotográficas - Plan de Desarrollo +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Análisis técnico](analisis-tecnico.md)** +- **[Requisitos funcionales](requisitos-funcionales.md)** + ## Fase 1 Backend: Configuración básica y autenticación - Configuración del entorno de desarrollo. diff --git a/docs/plan-testing.md b/docs/plan-testing.md index 12db0d2..8703474 100644 --- a/docs/plan-testing.md +++ b/docs/plan-testing.md @@ -8,4 +8,13 @@ Pruebas E2E: Flujos completos de usuario Pruebas de rendimiento: Carga de imágenes -Criterios de aceptación --> \ No newline at end of file +Criterios de aceptación --> + +# Galerías Fotográficas - Plan de Pruebas + +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Análisis técnico](analisis-tecnico.md)** +- **[Requisitos funcionales](requisitos-funcionales.md)** \ No newline at end of file diff --git a/docs/requisitos-funcionales.md b/docs/requisitos-funcionales.md index 1d15e44..7a978ed 100644 --- a/docs/requisitos-funcionales.md +++ b/docs/requisitos-funcionales.md @@ -2,6 +2,13 @@ --- +## Relacionado + +- **[Introducción](introduccion.md)** +- **[Acta de constitución](acta-constitucion.md)** +- **[Manual de usuario](manual-usuario.md)** +- **[Casos de uso](casos-uso.md)** + ## Gestión de usuarios (4 tipos: anónimo, cliente, profesional, administrador) Existirán 4 tipos de usuarios: diff --git a/mkdocs.yml b/mkdocs.yml index 07a8d77..c92c046 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,16 +1,11 @@ site_name: Galerías Fotográficas nav: - - Introducción: introduccion.md - - Acta de Constitución: acta-constitucion.md - Requisitos Funcionales: requisitos-funcionales.md - Análisis Técnico: analisis-tecnico.md - - Casos de Uso: casos-uso.md - - Decisiones Arquitectura: decisiones-arquitectura.md - - Documentación API: documentacion-api.md - Guía de Estilo: guia-estilo.md - - Plan de Desarrollo: plan-desarrollo.md - - Plan de Testing: plan-testing.md - - Manual de Usuario: manual-usuario.md + - Hoja de ruta: plan-desarrollo.md theme: - name: material + name: mkdocs + color_mode: auto + user_color_mode_toggle: true