/ Directorio / Playground / Codebase to Course
● Comunidad zarazhangrui ⚡ Instantáneo

Codebase to Course

por zarazhangrui · zarazhangrui/codebase-to-course

Apunta a un repositorio y obtén un 'curso' HTML único que lo explica como un tutorial — código anotado, diagramas, narrativa — para no ingenieros y nuevas incorporaciones.

codebase-to-course es un skill de Claude Code que recorre un repositorio completo y produce un curso HTML de archivo único que explica cómo funciona realmente la base de código. Está estructurado como un tutorial: arquitectura de alto nivel, luego inmersiones profundas por módulo, luego recorridos de 'sigue esta petición a través del sistema' — con fragmentos de código anotados embebidos. El output es un archivo HTML, sin pipeline de build.

Por qué usarlo

Características clave

Demo en vivo

Cómo se ve en la práctica

listo

Instalar

Elige tu cliente

~/Library/Application Support/Claude/claude_desktop_config.json  · Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

Abre Claude Desktop → Settings → Developer → Edit Config. Reinicia después de guardar.

~/.cursor/mcp.json · .cursor/mcp.json
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

Cursor usa el mismo esquema mcpServers que Claude Desktop. La configuración del proyecto prevalece sobre la global.

VS Code → Cline → MCP Servers → Edit
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

Haz clic en el icono MCP Servers de la barra lateral de Cline y luego en "Edit Configuration".

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

Mismo formato que Claude Desktop. Reinicia Windsurf para aplicar.

~/.continue/config.json
{
  "mcpServers": [
    {
      "name": "codebase-to-course-skill",
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ]
    }
  ]
}

Continue usa un array de objetos de servidor en lugar de un mapa.

~/.config/zed/settings.json
{
  "context_servers": {
    "codebase-to-course-skill": {
      "command": {
        "path": "git",
        "args": [
          "clone",
          "https://github.com/zarazhangrui/codebase-to-course",
          "~/.claude/skills/codebase-to-course"
        ]
      }
    }
  }
}

Añádelo a context_servers. Zed recarga en caliente al guardar.

claude mcp add codebase-to-course-skill -- git clone https://github.com/zarazhangrui/codebase-to-course ~/.claude/skills/codebase-to-course

Un solo comando. Verifica con claude mcp list. Quita con claude mcp remove.

Casos de uso

Usos del mundo real: Codebase to Course

Generar un curso de onboarding autodirigido para una nueva incorporación

👤 Managers de ingeniería / tech leads ⏱ ~45 min beginner

Cuándo usarlo: Viernes tras aceptar la oferta: quieres un artefacto de onboarding real en lugar de 've a leer el código'.

Requisitos previos
  • Skill instalado — git clone https://github.com/zarazhangrui/codebase-to-course ~/.claude/skills/codebase-to-course
  • Repositorio clonado — git clone estándar
Flujo
  1. Escanear el repositorio
    codebase-to-course: escanea ./our-app. Muestra la estructura del curso propuesto primero — lista de secciones — antes de escribir.✓ Copiado
    → TOC concreto: arquitectura, módulos, flujos de peticiones
  2. Generar el curso
    Se ve bien. Genera el HTML completo en /onboarding/course.html. Audiencia objetivo: nueva incorporación full-stack que conoce React + Node pero no nuestro dominio.✓ Copiado
    → Archivo HTML generado; se abre en el navegador
  3. Verificar precisión
    Verificación puntual: ¿el recorrido del 'flujo de auth' coincide con lo que hay realmente en src/auth/? Cita el código real.✓ Copiado
    → El recorrido cita rutas de archivo reales y código actual

Resultado: Un artefacto de onboarding real que ahorra al equipo 2 semanas de explicaciones.

Errores comunes
  • El curso es demasiado largo para leerlo realmente — Especifica el número máximo de secciones; calidad sobre exhaustividad
  • Los fragmentos de código quedan obsoletos — Regenera después de los refactors principales; el skill es rápido
Combinar con: filesystem · git-mcp-idosal

Explicar una característica compleja a un PM no técnico

👤 Tech leads ⏱ ~20 min beginner

Cuándo usarlo: El PM sigue preguntando '¿por qué tarda 3 sprints?' — quieres un artefacto concreto.

Flujo
  1. Acotar a la característica
    codebase-to-course: acota a src/payments/. Audiencia: PM sin experiencia de ingeniería. Apoya en diagramas + analogías, poco código.✓ Copiado
    → El curso es de alto nivel; los bloques de código son mínimos

Resultado: El PM se va con un modelo mental.

Errores comunes
  • Las analogías simplifican en exceso — Verifica puntualmente; el skill prefiere la precisión si se lo pides

Generar una página 'cómo funciona' para tu proyecto open source

👤 Mantenedores de OSS ⏱ ~30 min intermediate

Cuándo usarlo: Tu README tiene características pero no un explicador arquitectónico.

Flujo
  1. Generar como página de documentación
    codebase-to-course: escanea la rama principal. Genera ARCHITECTURE.html para el sitio de documentación. Objetivo: devs experimentados evaluando el proyecto.✓ Copiado
    → El output se lee como una guía reflexiva para contribuidores

Resultado: Mejor experiencia de desarrollador para evaluadores y contribuidores.

Errores comunes
  • El curso tiene branding incorrecto (parece genérico) — Pasa el nombre del proyecto + claves de estilo en el prompt

Combinaciones

Combínalo con otros MCPs para multiplicar por 10

codebase-to-course-skill + filesystem

Leer el repositorio local y escribir el curso

codebase-to-course: escanea ./our-app, escribe /onboarding/course.html.✓ Copiado
codebase-to-course-skill + git-mcp-idosal

Cursar un repositorio externo sin clonarlo

Usa GitMCP para owner/repo. Luego codebase-to-course sobre eso.✓ Copiado

Herramientas

Lo que expone este MCP

HerramientaEntradasCuándo llamarCoste
scan_repo path Siempre primero 0
propose_toc scan_result, audience Después del escaneo, antes de la generación 0
generate_course scan_result, toc, target_html_path Paso final 0
scope_to_subdir subdir_path Monorepo grande o foco en una característica 0

Coste y límites

Lo que cuesta ejecutarlo

Cuota de API
N/A
Tokens por llamada
Significativo — el skill lee el repositorio completo (típicamente 10k–50k tokens)
Monetario
Gratis; tus tokens del modelo aplican
Consejo
Para monorepos, usa scope_to_subdir; no curses todo a la vez

Seguridad

Permisos, secretos, alcance

Ámbitos mínimos: filesystem-read filesystem-write
Almacenamiento de credenciales: Ninguno
Salida de datos: Ninguno — lectura/escritura puramente local

Resolución de problemas

Errores comunes y soluciones

El curso es demasiado genérico / no referencia código real

Haz el prompt más específico; pide citas de archivo:línea

El repositorio es demasiado grande; se agota el contexto

Usa scope_to_subdir; crea cursos por módulo y enlázalos

Formato HTML roto

Pide al skill que valide el output; regenera si es necesario

Alternativas

Codebase to Course vs otros

AlternativaCuándo usarlaContrapartida
Repomix + prompt manualQuieres control total sobre cómo se alimenta la base de código a ClaudeMás configuración; sin formato de output opinionado
DocsGPT / MintlifyQuieres documentación alojadaProducto diferente; no es HTML de archivo único
absolutely-skilled / autodocQuieres documentación de API autogeneradaReferencia de API ≠ tutorial

Más

Recursos

📖 Lee el README oficial en GitHub

🐙 Ver issues abiertas

🔍 Ver todos los 400+ servidores MCP y Skills