Moxie Docs

¿Qué es Moxie Docs?

Moxie Docs es un sistema de documentación para repositorios de GitHub que genera y mantiene automáticamente la documentación de la base de código. Indexa un repositorio, crea documentación con búsqueda sobre arquitectura, convenciones y guías paso a paso, y vuelve a comprobar esas páginas cuando el código cambia para poder detectar y reescribir material desactualizado.

También expone convenciones del repositorio y contexto verificado a herramientas de IA mediante MCP, con acceso de solo lectura limitado a la tarea. Además, puede abrir una pull request semanal de “Friday Cleanup” solo de docs para recopilar el drift acumulado durante la semana.

Características clave

• Indexación continua del repositorio: Moxie se conecta a un repositorio de GitHub y mantiene el índice actualizado a medida que se hacen merges, de modo que la documentación queda ligada al código más reciente.
• Documentación generada y con citas de origen: Crea páginas de arquitectura, convenciones y guías paso a paso con citas al código fuente, lo que facilita verificar el resultado.
• Detección de drift al hacer merge: Cuando los cambios de código afectan a la documentación existente, Moxie marca el drift y regenera las páginas relevantes en lugar de dejarlas obsoletas.
• Contexto MCP para agentes: Herramientas de IA como Cursor, Claude Code y Codex pueden obtener convenciones, documentación y comandos verificados por MCP sin volver a rastrear el repositorio en cada prompt.
• PRs de Friday Cleanup: Una vez a la semana, Moxie puede abrir una pull request solo de docs para recopilar y presentar las actualizaciones de documentación para su revisión.
• Comprobaciones del flujo de trabajo de PRs: Puede revisar las pull requests para detectar impacto en la documentación y coherencia de la descripción antes del merge, dejando los cambios de código y el control del merge en manos del equipo.

Cómo usar Moxie Docs

Empieza conectando un repositorio de GitHub. Moxie indexa la base de código, genera el primer conjunto de documentación y resume las convenciones que pueden reutilizar humanos o agentes de IA.

A partir de ahí, los equipos lo usan de dos maneras principales: revisar la documentación que Moxie genera y actualiza, y dejar que compruebe las nuevas pull requests en busca de documentación obsoleta o descripciones que no coincidan. Si se desea, la integración MCP puede usarse para que los agentes de programación obtengan contexto específico del repositorio de forma limitada y de solo lectura.

Casos de uso

• Mantener actualizada la documentación de arquitectura: Un equipo mantiene páginas como el comportamiento de webhooks o los flujos de facturación, y Moxie actualiza la documentación cuando llegan cambios en el código relacionado.
• Proporcionar contexto del repositorio a agentes de programación: Los desarrolladores que usan Cursor, Claude Code o Codex pueden recuperar convenciones y comandos verificados sin navegar manualmente por el repositorio.
• Revisar el drift de documentación cada semana: Los equipos que quieren una cadencia regular de limpieza pueden revisar la pull request semanal de Friday Cleanup en lugar de perseguir páginas obsoletas de forma ad hoc.
• Comprobar el impacto de una PR antes del merge: Los mantenedores pueden ver si una pull request afecta a la documentación o requiere reescribir la descripción antes de fusionarla.
• Incorporar nuevos ingenieros: Los nuevos colaboradores pueden buscar documentación generada y marcadores en un solo espacio de trabajo en lugar de leer varios archivos fuente para entender las convenciones.

FAQ

¿Moxie cambia mi código automáticamente? No. La fuente indica que los cambios de código siguen bajo control del equipo. Las actualizaciones de documentación se entregan como pull requests de solo docs revisables, y los ajustes de coherencia de la descripción editan la descripción de la PR en lugar del código.

¿Qué ocurre después de conectar un repositorio? Moxie indexa el repositorio, genera documentación con búsqueda, resume las convenciones y empieza a comprobar las nuevas pull requests en busca de impacto en la documentación y coherencia de la descripción.

¿El acceso al repositorio está limitado? Sí. La descripción del producto indica que el acceso es de solo lectura por defecto y está limitado por repositorio, y que el contexto MCP se restringe a la tarea en lugar de a toda la base de código.

¿Qué tipos de documentación genera? La página menciona específicamente páginas de arquitectura, convenciones, guías paso a paso y documentación sobre temas como webhooks de facturación.

¿Funciona solo con GitHub? La página está escrita para repositorios de GitHub, así que GitHub es la fuente compatible descrita aquí.

Alternativas

• Documentación manual en Markdown o una wiki de documentación: Es la alternativa más sencilla, pero no revalida automáticamente la documentación frente al código ni genera actualizaciones con citas de origen.
• Herramientas generales de búsqueda de código y exploración de repositorios: Ayudan a inspeccionar archivos, pero no ofrecen una capa de documentación mantenida ni PRs de limpieza solo de docs.
• Asistentes de programación con IA independientes sin docs conscientes del repositorio: Pueden responder preguntas y editar código, pero siguen dependiendo de que el modelo redescubra el contexto, salvo que se combinen con un sistema como Moxie.
• Flujos internos de documentación basados en pull requests y revisión: Los equipos pueden gestionar la documentación manualmente mediante PRs, pero deben crear y hacer seguimiento ellos mismos de las comprobaciones de drift en lugar de generarlas desde la base de código.