Gramax — docs-as-code de código abierto con Git

Gramax: Plataforma de Documentación como Código de Código Abierto con Integración Git

Los equipos que enfrentan problemas de sincronización de GitBook con repositorios de GitHub encuentran en Gramax una alternativa robusta de código abierto. La plataforma almacena la documentación en archivos Markdown de Git, garantizando control total de los datos sin restricciones de la nube. Para proyectos con datos sensibles, esto es crucial: los archivos permanecen en tu propia infraestructura.

Gramax implementa un enfoque de documentación como código: la edición, la aprobación de cambios mediante pull requests y la publicación ocurren de forma nativa en Git. El soporte de editor visual mantiene Markdown como formato base, añadiendo compatibilidad con Mermaid, PlantUML, Draw.io y OpenAPI.

Características Clave para Desarrolladores

Gramax está diseñado para la colaboración en equipo en documentación:

• Integración Nativa con Git: Los cambios se realizan en la aplicación, pasan por PRs y se despliegan automáticamente al sitio.
• Búsqueda IA y Copiloto: Conecta modelos locales para búsqueda semántica con citas de fuentes.
• Editor Visual: Interfaz WYSIWYG con exportación a Markdown, compatible con diagramas y especificaciones.
• Portal Público: Aloja sitios de documentación por tu cuenta sin costo.
• Completamente Gratuito: Código abierto sin modelos freemium ni límites de usuarios.

El soporte es receptivo: un chat de desarrolladores en Telegram para discutir problemas.

Configuración del Repositorio Paso a Paso

Para conectar un repositorio Git existente:

• Ve a app.gram.ax y selecciona "Subir Directorio Existente".
• Especifica el proveedor: GitHub, GitLab o autoalojado.
• Elige un repositorio de tu organización o cuenta personal.
• Después de subir, crea una carpeta para la documentación (por ejemplo, /docs).
• Establece la ruta de la carpeta en la configuración del catálogo.
• Añade un archivo Markdown mediante el editor visual.
• Publica los cambios: botón de nube para git push, flechas para git pull.

Revertir cambios es posible a través de la interfaz: visualiza la diferencia y deshaz. La sincronización es bidireccional: las ediciones en el editor de código se reflejan en Gramax, y viceversa. Se recomienda una extensión de Markdown para VS Code para trabajo local.

Documentación como Código en la Práctica

A diferencia de los servicios en la nube, Gramax elimina los riesgos de bloqueo: todos los datos están en tu Git. Para proyectos de IA con datos confidenciales, esto garantiza cumplimiento sin compromisos. Los equipos de desarrolladores de nivel medio a senior apreciarán la ausencia de dependencia del proveedor y la facilidad de migración.

Las funciones de IA permiten configurar búsquedas en bases de conocimiento: el modelo genera respuestas con enlaces precisos a archivos MD. La visualización mediante Mermaid simplifica la documentación de arquitectura, y la integración con OpenAPI maneja especificaciones de API.

Publicación en un sitio público: configura un dominio, CI/CD mediante GitHub Actions para despliegue automático en Vercel o Netlify.

Conclusiones Clave

• Gramax es completamente de código abierto, sin tarifas ocultas ni límites.
• La documentación se almacena en Markdown de Git, asegurando control de versiones y supervisión.
• Soporte de búsqueda IA con modelos locales para privacidad.
• PRs nativos y publicación para desarrollo en equipo.
• Soporte rápido mediante el chat de Telegram de desarrolladores.

— Editorial Team