Refactor code structure for improved readability and maintainability
Some checks failed
CI / lint (push) Failing after 1m4s
CI / test-backend (push) Has been skipped
CI / test-frontend (push) Has been skipped
CI / test-e2e (push) Has been skipped

This commit is contained in:
2026-02-22 18:18:46 +01:00
parent c27e9bec7a
commit 0c9c408564
98 changed files with 8207 additions and 5250 deletions

92
docs/README.md Normal file
View File

@@ -0,0 +1,92 @@
# Documentación del Proyecto Quasar 📚
Esta documentación está organizada en secciones lógicas para facilitar la navegación y mantenimiento.
## Estructura de la Documentación
```
docs/
├── README.md # Este archivo (índice general)
├── 01-conceptos/ # Conceptos fundamentales y requisitos
│ ├── requirements.md # Requisitos funcionales y no funcionales
│ ├── architecture.md # Arquitectura técnica general
│ └── data-model.md # Modelo de datos y esquema
├── 02-tecnico/ # Documentación técnica detallada
│ ├── apis.md # APIs del sistema (consolidado)
│ ├── frontend.md # Documentación del frontend
│ └── lessons-learned.md # Lecciones aprendidas y recomendaciones
├── 03-analisis/ # Análisis comparativos y estudios
│ └── competitive-analysis.md # Análisis competitivo
└── 04-operaciones/ # Guías de operación y despliegue
```
## Guía de Navegación
### 🎯 Para nuevos desarrolladores
1. Comienza con [`01-conceptos/requirements.md`](01-conceptos/requirements.md) para entender el propósito
2. Lee [`01-conceptos/architecture.md`](01-conceptos/architecture.md) para la visión general
3. Revisa [`01-conceptos/data-model.md`](01-conceptos/data-model.md) para entender los datos
### 🔧 Para trabajo técnico
1. Consulta [`02-tecnico/apis.md`](02-tecnico/apis.md) para APIs y configuración
2. Revisa [`02-tecnico/frontend.md`](02-tecnico/frontend.md) para detalles del frontend
3. Lee [`02-tecnico/lessons-learned.md`](02-tecnico/lessons-learned.md) para buenas prácticas
### 📊 Para análisis y decisiones
1. Revisa [`03-analisis/competitive-analysis.md`](03-analisis/competitive-analysis.md) para contexto del mercado
### 🚀 Para operaciones y despliegue
1. Las guías de operación están en desarrollo (sección `04-operaciones/`)
## Convenciones
### Formato de enlaces
Todos los enlaces internos usan formato markdown estándar:
```markdown
[texto de enlace](ruta/al/archivo.md)
```
### Nomenclatura de archivos
- Todos los usan `kebab-case.md`
- Los prefijos numéricos indican orden de lectura
### Estructura de documentos
- Cada documento tiene tabla de contenidos (TOC)
- Secciones numeradas para mejor navegación
- Ejemplos de código con formato sintáctico
## Estado Actual
| Sección | Estado | Comentarios |
| -------------- | ---------------- | ------------------------------------ |
| 01-conceptos | ✅ Completa | Documentación fundamental estable |
| 02-tecnico | ✅ Actualizada | APIs consolidados, frontend completo |
| 03-analisis | ✅ Completa | Análisis competitivo actualizado |
| 04-operaciones | 🚧 En desarrollo | Guías de operación pendientes |
## Próximos Pasos
- [ ] Añadir documentación de testing y CI/CD
- [ ] Crear índice temático para búsqueda rápida
- [ ] Documentar API REST detallada
## Contribuir
Al agregar nuevo contenido:
1. Coloca el documento en la sección adecuada
2. Sigue las convenciones de nomenclatura
3. Actualiza este README si agregas nuevas secciones
4. Revisa y actualiza referencias cruzadas
---
_Última actualización: 2026-02-22_