Mejora completa de la documentación y actualización de README#108
Merged
betilloXann merged 3 commits intomainfrom Jan 18, 2026
Merged
Mejora completa de la documentación y actualización de README#108betilloXann merged 3 commits intomainfrom
betilloXann merged 3 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Esta solicitud de extracción mejora significativamente la documentación del proyecto “Sistema de Acompañamiento Tutorial”. Introduce nuevos archivos de documentación técnica, mejora el
README.mdprincipal y la página de inicio para mayor claridad y profesionalismo, y detalla la arquitectura del sistema, el flujo de trabajo, el diseño de la base de datos, la estructura del código, la pipeline de CI/CD y la información del equipo. Estos cambios proporcionan una visión completa, bien organizada y moderna del proyecto tanto para desarrolladores como para stakeholders.Los cambios clave incluyen:
1. Renovación y modernización completa de la documentación
README.mdpara incluir badges del proyecto, enlaces de demo, descarga de APK, resumen del stack tecnológico, pasos de instalación y resumen del proyecto, haciéndolo más atractivo e informativo.docs/index.md) para presentar mejor el propósito del proyecto, sus funcionalidades y la navegación, con mejoras visuales e instrucciones de descarga.2. Adición de documentación técnica detallada
docs/arquitectura.mddescribiendo el flujo del sistema con un diagrama Mermaid, detallando la automatización de procesos y responsabilidades de los actores.docs/base_datos.mddocumentando la arquitectura de la base de datos y el modelo entidad-relación, incluyendo un diagrama ER en Mermaid.docs/casos_uso.mddetallando los actores del sistema, casos de uso principales y un diagrama de casos de uso.docs/estructura_codigo.mdexplicando la organización del código, estructura de carpetas y aplicación del patrón MVVM.docs/ci_cd.mddescribiendo la pipeline de CI/CD, estrategia de automatización y enfoque de pruebas, con un diagrama de flujo detallado.3. Actualizaciones sobre el equipo y contexto del proyecto
docs/equipo.mdpara proporcionar información clara sobre el equipo de desarrollo, sus roles y el contexto institucional, reemplazando el formato anterior basado en tablas por descripciones concisas.Estas mejoras hacen que el proyecto sea mucho más accesible para nuevos contribuyentes y proporcionan una presentación profesional para revisiones académicas e institucionales.