Skip to content

DOCS.md

Latest commit

 

History

History
91 lines (62 loc) · 3.76 KB

DOCS.md

File metadata and controls

91 lines (62 loc) · 3.76 KB

📚 Documentación de ESPAlert

Bienvenido a la documentación de ESPAlert. Este proyecto proporciona documentación completa en español e inglés.

🌍 Selecciona tu idioma

🇪🇸 Documentación en Español

Documentos Principales

Documento Descripción
docs/es/README.md Introducción al proyecto, arquitectura, instalación rápida y guía de desarrollo
docs/es/CONTRIBUTING.md Guía para contribuidores: flujo de trabajo, convenciones y cómo enviar un PR
docs/es/ROADMAP.md Plan de desarrollo, épicas por versión y criterios de finalización
docs/es/CHANGELOG.md Registro de cambios notables en cada release
docs/es/CODE_OF_CONDUCT.md Código de conducta del proyecto
docs/es/SECURITY.md Política de seguridad y cómo reportar vulnerabilidades
docs/es/TRADEMARK_POLICY.md Política de marca y uso del logotipo

Documentación por Módulo

Módulo Descripción
apps/web/README.md Frontend Next.js: estructura, desarrollo local y scripts

🇬🇧 English Documentation

Main Documents

Document Description
README.md Project introduction, architecture, quick start, and development guide
CONTRIBUTING.md Contributor guide: workflow, conventions, and how to submit a PR
docs/ROADMAP.md Development plan, epics by version, and completion criteria
docs/CHANGELOG.md Notable changes in each release
CODE_OF_CONDUCT.md Project code of conduct
SECURITY.md Security policy and vulnerability reporting
docs/TRADEMARK_POLICY.md Trademark policy and logo usage

Module Documentation

Module Description
apps/web/README.en.md Next.js frontend: structure, local development, and scripts

🚀 Empezar Rápido / Quick Start

🇪🇸 Para Desarrolladores Españoles

  1. Comienza con docs/es/README.md — Overview del proyecto y requisitos.
  2. Busca issues con label good first issue — Encuentra tu primer issue.
  3. Consulta docs/es/CONTRIBUTING.md — Flujo de trabajo y convenciones.
  4. Revisa docs/es/ROADMAP.md — Conoce las próximas features.

🇬🇧 For English-Speaking Developers

  1. Start with README.md — Project overview and requirements.
  2. Look for issues with good first issue label — Find your first issue.
  3. Read CONTRIBUTING.md — Workflow and conventions.
  4. Review docs/ROADMAP.md — Upcoming features.

🔗 Enlaces Útiles / Useful Links

❓ ¿Tienes Preguntas? / Questions?

  • Abre una Discussion en GitHub
  • Reporta un bug usando Issues
  • Contacta a los mantenedores vía correo privado

Última actualización / Last update: 2026-03-05