Documentación Principal¶

Bienvenido a la documentación de Ether My Best Practice.

Contenidos¶

Resumen¶

Ether My Best Practice es una plantilla de buenas prácticas orientada a proyectos de API REST donde las reglas deben poder ser consumidas por agentes de IA y reutilizadas como contexto operativo:

🏗️ Arquitectura hexagonal
📝 Documentación como código (Markdown + MermaidJS + MkDocs)
✅ Testing y TDD
🔄 Git Flow y Conventional Commits
🚀 CI automatizado con podman/Containerfile
🛠️ Stack tecnológico predefinido para consistencia
🤖 Integración con agentes de IA (MCP)

Arquitectura del estándar¶

graph TD
    R[Reglas en rules/] --> AG[Agentes de IA]
    T[Templates en templates/] --> AG
    AG --> PJ[Proyecto Consumidor]
    R --> DOC[MkDocs site/]
    subgraph "Stack Recomendado"
        J[Java Temurin 25]
        N[Node LTS]
        P[Python 3.12+]
        PD[podman]
        CF[Containerfile]
        MK[MkDocs + MermaidJS]
        AL[Alpine base]
    end

Enfoque¶

Este repositorio combina dos piezas:

Reglas versionadas en ../rules/00-index.md para decirle a humanos y agentes cómo trabajar.
Plantillas en ../templates/ para que un agente pueda generar el cascarón inicial de una API REST coherente con esas reglas.

La combinación permite que un MCP o un agente local no solo lea normas, sino que también tenga una base estructural para crear archivos y carpetas siguiendo el estándar.

Para Empezar¶

Lee Getting Started
Consulta las Reglas
Usa las Plantillas