Skip to content

Latest commit

 

History

History

README.md

📚 Documentación de StackCode

¡Bienvenido al hub de documentación de StackCode! Este directorio contiene documentación completa para desarrolladores, contribuidores y organizaciones que usan StackCode.

📋 Navegación Rápida

🏗️ Documentación Principal

🏛️ Decisiones Arquitecturales

🌐 Traducciones

🎯 Documentación por Audiencia

👩‍💻 Para Desarrolladores Usando StackCode

Comienza aquí si quieres usar StackCode en tus proyectos:

  1. README Principal - Visión general del proyecto y primeros pasos
  2. Stacks de Tecnología - Ve qué tipos de proyecto son soportados
  3. Guía de Auto-hospedaje - Despliega para tu organización

🛠️ Para Contribuidores

Comienza aquí si quieres contribuir a StackCode:

  1. Guía de Contribución - Cómo contribuir efectivamente
  2. Guía de Arquitectura - Entiende la base de código
  3. Directorio ADR - Aprende sobre decisiones arquitecturales

🏢 Para Organizaciones

Comienza aquí si quieres desplegar StackCode internamente:

  1. Guía de Auto-hospedaje - Despliegue y personalización
  2. Guía de Arquitectura - Visión técnica general
  3. Guía de Contribución - Cómo contribuir mejoras de vuelta

🔧 Referencia Técnica

Estructura del Proyecto

docs/
├── README.md                 # Este archivo
├── ARCHITECTURE.md           # Arquitectura técnica
├── CONTRIBUTING.md           # Directrices de contribución
├── SELF_HOSTING_GUIDE.md     # Guía de despliegue
├── STACKS.md                 # Tecnologías soportadas
├── adr/                      # Registros de Decisiones Arquitecturales
│   ├── README.md
│   ├── 001-monorepo-structure.md
│   ├── 002-typescript-esm.md
│   ├── 003-cli-design.md
│   └── 004-i18n-strategy.md
├── pt-BR/                    # Traducciones en portugués
│   └── README.md
└── es/                       # Traducciones en español
    └── README.md

Conceptos Clave

  • Arquitectura Monorepo: StackCode usa un monorepo con múltiples paquetes
  • Sistema de Plantillas: Plantillas de proyecto configurables para diferentes tecnologías
  • CLI + Extensión VS Code: Múltiples interfaces para la misma funcionalidad principal
  • Internacionalización: Soporte multi-idioma en todas las interfaces

🤝 Contribuyendo a la Documentación

¡Acogemos mejoras a nuestra documentación! Así es como puedes ayudar:

Correcciones Rápidas

  • Corrige errores tipográficos, enlaces rotos o explicaciones poco claras
  • Añade ejemplos o mejora los existentes
  • Actualiza información desactualizada

Contribuciones Principales

  • Escribe nuevas guías o tutoriales
  • Crea documentación para nuevas características
  • Ayuda con traducciones

Ayuda con Traducciones

  • Traduce documentación existente a tu idioma
  • Revisa traducciones de otros contribuidores
  • Mantén consistencia entre traducciones

Ve nuestra Guía de Contribución para instrucciones detalladas.

🎓 Modo Educativo

StackCode incluye un Modo Educativo único que transforma la herramienta en un sistema de aprendizaje interactivo. Esta característica es perfecta para desarrolladores que quieren aprender mejores prácticas de DevOps mientras trabajan.

Cómo Funciona

  • Explicaciones Contextuales: Cada acción viene con una explicación del "por qué" detrás de la decisión
  • Configurable: Puede ser habilitado globalmente o usado bajo demanda
  • Completamente Traducido: Disponible en español, português e inglés

Configuración

# Habilitar globalmente (siempre muestra explicaciones)
stackcode config set educate true

# Usar bajo demanda con cualquier comando
stackcode validate "feat: nueva funcionalidad" --educate
stackcode commit --educate
stackcode init --educate

# Configurar interactivamente
stackcode config

Beneficios

  • Aprendizaje Práctico: Aprende mejores prácticas mientras usas la herramienta
  • Incorporación de Equipos: Perfecto para nuevos miembros del equipo
  • Documentación Viva: Explicaciones siempre actualizadas y contextuales

Para más detalles, consulta la Guía del Modo Educativo.

🔗 Recursos Externos

📞 Obteniendo Ayuda

¿Necesitas ayuda con StackCode?


Última actualización: Septiembre 2025 | Equipo de Documentación StackCode