Documentos del repositorio (Repo Docs)
Abrir la aplicación: Documenta un repositorio → (products.documentize.ai)
En una frase
Repo Docs lee un repositorio de GitHub, le escribe un sitio de documentación (visión general, arquitectura, proyectos, referencia de API, diagramas y más) y lo entrega como un pull request más una descarga en zip.
Qué lo hace único
- Se basa en tu código. Primero se indexa el código y luego la IA lo explica. Cada nombre de tipo o de miembro que escribe la IA se comprueba contra ese índice; los nombres que no existen se corrigen o se eliminan, y un informe de calidad enumera lo que se comprobó.
- Termina en un pull request, no solo en un archivo. El pull request cambia únicamente archivos generados; la documentación escrita a mano nunca se toca.
- Se puede reanudar. Una ejecución que alcanza el límite de tiempo conserva lo que terminó, y Continuar retoma el resto.
Cuándo usarlo y cuándo no
- Úsalo para dar a un repositorio su primer conjunto real de documentación, para refrescar la documentación tras un cambio importante o para incorporar a nuevos colaboradores.
- No sirve para un modelo de datos consultable del código → Code Graph.
- No sirve para una biblioteca compilada cuyo código fuente no puedes ver → Chat de Assembly (Assembly Chat).
- No sirve para lenguajes que no estén en la lista. Admitidos: .NET (C#), TypeScript, Python, Java y Go. Los demás archivos no se documentan.
Antes de empezar
- Un repositorio de GitHub, como
owner/nameo una URL (una URL con/tree/<branch>selecciona esa rama). - ¿Repositorio privado? Invita como colaborador a la cuenta de GitHub
arise-project; el pull request irá entonces directo a tu repositorio. Sin eso, la página dice que el pull request se abre en el propio fork dearise-project(esto solo funciona con los repositorios que puede leer; para un repositorio privado necesitas la invitación). - Privacidad: el repositorio se copia a una carpeta temporal durante la ejecución y se elimina después. Las explicaciones de IA de un repositorio se guardan en caché para acelerar ejecuciones posteriores; la página dice que el código en sí no se conserva. Se envían fragmentos de código a un modelo de lenguaje para escribir las explicaciones, así que no lo ejecutes sobre código que no tengas permiso para compartir con ese servicio.
Paso a paso
- Escribe el repositorio de GitHub y, si hace falta, la rama.
- Elige las secciones, la audiencia y el nivel de detalle (más abajo). Si una solución de .NET tiene varias, escribe la ruta de Solución.
- Define el idioma de salida y la carpeta Docs si no quieres
docs. - Inicia la ejecución. El pull request se abre pronto como borrador (su enlace aparece en pocos minutos) y se actualiza a medida que avanza la ejecución.
- Cuando termine la ejecución, abre el pull request o descarga el zip. Si el resultado dice que la documentación es parcial, pulsa Continuar documentación.
- Tus ejecuciones aparecen en «Tus repositorios» (guardadas en este navegador), donde puedes seguirlas, Ejecutar de nuevo o eliminarlas.
Opciones explicadas
| Opción | Qué hace | Valor por defecto | Recomendado |
|---|---|---|---|
| Solución (.sln) (solo .NET) | Un .sln, .slnx o .csproj del repositorio que se va a documentar | se encuentra automáticamente | Defínela cuando el repositorio tenga varias soluciones |
| Secciones | Resumen, Arquitectura, Proyectos, Características, Referencia de API, Diagramas (activadas); Ejemplos, Glosario (desactivadas) | seis activadas | Añade Ejemplos y Glosario para bibliotecas públicas |
| Audiencia | Nuevos colaboradores, Usuarios de API o Ambos | Ambos | Elige una para acortar el resultado |
| Nivel de detalle | Breve, Estándar, Minucioso | Estándar | Breve para un primer vistazo |
| Idioma de salida | Predeterminado (inglés) o uno de de, fr, es, it, pt, nl, pl, ru, uk, tr, ar, hi, ja, ko, zh | inglés | Adáptalo a tus lectores |
| Carpeta Docs | Carpeta del repositorio donde van los documentos (no dentro de .git ni de .github) | docs | Deja el valor por defecto |
| Full member signatures (firmas completas de los miembros) | Muestra las firmas completas en la referencia de API | activado | Déjalo activado |
| Incluir tipos internos | Documenta también los tipos internos | desactivado | Solo para documentación de colaboradores |
| Mejorar el README | Propone un README mejor como un commit independiente | desactivado | Pruébalo; descarta el commit si no te gusta |
Si tu carpeta de documentación ya contiene páginas escritas a mano, la documentación generada va en cambio a una subcarpeta repodocs, de modo que nada de lo tuyo estorbe.
Qué obtienes
- Un pull request de
arise-project(borrador mientras es parcial, marcado como listo para revisión cuando la cobertura es completa). Los pull requests de documentación anteriores, de commits previos, se cierran con un enlace al nuevo. - Un zip con páginas Markdown, una configuración de MkDocs (la página menciona también una configuración de DocFX), un sitio HTML y un PDF. Los diagramas son Mermaid: dependencias entre proyectos, familias de componentes y registros de inyección de dependencias.
- Un panel de resultados: páginas planificadas y terminadas, cuántas explicaciones de IA se escribieron, enlaces rotos y el estado del pull request.
Calidad y límites
- Texto escrito por IA sobre un índice exacto del código. Todo se construye a partir de un solo commit, y la página muestra cuál.
- Una ejecución gratuita se detiene a los 15 minutos con lo que haya terminado; un plan de pago termina la documentación en una sola ejecución.
- Las ejecuciones de Continuar no se contabilizan: el código trata un Continuar como no facturado, y debe continuar una ejecución anterior real del mismo repositorio. El texto de la página dice que Continuar termina el resto sin coste.
- El código nunca se compila ni se ejecuta.
Funciona bien con
- Ejecuta antes de esta aplicación: Code Graph para el mapa estructural; Actualizador de NuGet (NuGet Updater) para mantener las dependencias al día.
- Ejecuta después de esta aplicación: un despliegue con MkDocs o GitHub Pages del resultado del pull request.
- Relacionado: Confianza, verificación y límites de lo que produce la IA.
Errores frecuentes y soluciones
- El pull request es un borrador → la documentación es parcial; pulsa Continuar.
- No hay pull request, pero sí un zip → falló la entrega (por ejemplo, por falta de acceso). El zip contiene la misma documentación.
- «Select at least one section» → marca al menos una.
- Carpeta Docs rechazada → debe ser una ruta relativa dentro del repositorio.
- Se documentó la solución equivocada → define Solución de forma explícita.
Lo mismo en otros canales
No verificado para esta aplicación. Consulta canales.
Pruébalo
Ejecuta Repo Docs sobre un repositorio público pequeño con nivel de detalle Breve, solo las secciones Resumen y Arquitectura, y la carpeta por defecto. Abre el pull request en borrador cuando aparezca su enlace, lee la página de arquitectura y comprueba con el código el nombre de una clase que mencione.