Codebase to Course (Claude Skill) — Instalar & Demo ao vivo

Por que usar

Principais recursos

Saída HTML de arquivo único — sem pipeline de build
Visão geral de arquitetura gerada a partir do código real (não do README)
Seções por módulo: 'por que isso existe + como funciona'
Walkthroughs de fluxo de requisição que seguem entrypoints reais
Blocos de código anotados com explicações linha a linha
Projetado para não-engenheiros (PMs, designers, novos contratados)

Demo ao vivo

Como fica na prática

pronto

Instalar

Escolha seu 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
    }
  }
}

Abra Claude Desktop → Settings → Developer → Edit Config. Reinicie após salvar.

~/.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 o mesmo esquema mcpServers que o Claude Desktop. Config de projeto vence a 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
    }
  }
}

Clique no ícone MCP Servers na barra lateral do Cline, depois "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
    }
  }
}

Mesmo formato do Claude Desktop. Reinicie o 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"
      ]
    }
  ]
}

O Continue usa um array de objetos de servidor em vez de um map.

~/.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"
        ]
      }
    }
  }
}

Adicione em context_servers. Zed recarrega automaticamente ao salvar.

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

Uma linha só. Verifique com claude mcp list. Remova com claude mcp remove.

Casos de uso

Usos do mundo real: Codebase to Course

Gere um curso de onboarding autoguiado para um novo contratado

👤 Gerentes de engenharia / tech leads ⏱ ~45 min beginner

Quando usar: Sexta após oferta aceita: você quer um artefato real de onboarding em vez de 'vá ler o código'.

Pré-requisitos

Skill instalada — git clone https://github.com/zarazhangrui/codebase-to-course ~/.claude/skills/codebase-to-course
Repositório clonado — git clone padrão

Fluxo

Escaneie o repositório

codebase-to-course: escaneie ./our-app. Produza primeiro a estrutura proposta do curso — lista de seções — antes de escrever.✓ Copiado

→ TOC concreto: arquitetura, módulos, fluxos de requisição
Gere o curso

Parece bom. Gere o HTML completo em /onboarding/course.html. Público-alvo: novo contratado fullstack que conhece React + Node mas não nosso domínio.✓ Copiado

→ Arquivo HTML gerado; abre no browser
Verifique a precisão

Verificação pontual: o walkthrough do 'fluxo de autenticação' corresponde ao que está em src/auth/? Cite o código real.✓ Copiado

→ O walkthrough cita caminhos de arquivo reais e código atual

Resultado: Um artefato real de onboarding que poupa à equipe 2 semanas de explicações.

Armadilhas

Curso é longo demais para ser lido de verdade — Especifique o número máximo de seções; qualidade sobre completude
Trechos de código ficam obsoletos — Regenere após grandes refactors; a skill é rápida

Combine com: filesystem · git-mcp-idosal

Explique uma funcionalidade complexa para um PM não técnico

👤 Tech leads ⏱ ~20 min beginner

Quando usar: O PM continua perguntando 'por que isso leva 3 sprints' — você quer um artefato concreto.

Fluxo

Delimite para a funcionalidade

codebase-to-course: delimite para src/payments/. Público: PM sem background de engenharia. Prefira diagramas + analogias, pouco código.✓ Copiado

→ Curso é de alto nível; blocos de código mínimos

Resultado: PM sai com modelo mental claro.

Armadilhas

Analogias simplificam demais — Verifique pontualmente; a skill prefere precisão quando pressionada

Gere uma página 'como funciona' para seu projeto open source

👤 Mantenedores OSS ⏱ ~30 min intermediate

Quando usar: Seu README tem funcionalidades mas nenhuma explicação arquitetural.

Fluxo

Gere como página de documentação

codebase-to-course: escaneie a branch main. Produza ARCHITECTURE.html para o site de documentação. Público-alvo: devs experientes avaliando o projeto.✓ Copiado

→ Saída lida como um guia do contribuidor bem elaborado

Resultado: Melhor experiência para avaliadores e contribuidores.

Armadilhas

Curso visualmente genérico (parece sem marca) — Passe o nome do projeto + indicações de estilo no prompt

Combinações

Combine com outros MCPs para 10× de alavancagem

codebase-to-course-skill + filesystem

Leia o repositório local e escreva o curso

codebase-to-course: escaneie ./our-app, escreva /onboarding/course.html.✓ Copiado

codebase-to-course-skill + git-mcp-idosal

Crie um curso de um repositório externo sem clonar

Use GitMCP para owner/repo. Depois codebase-to-course em cima disso.✓ Copiado

Ferramentas

O que este MCP expõe

Ferramenta	Entradas	Quando chamar
scan_repo	path	Sempre primeiro
propose_toc	scan_result, audience	Após scan, antes da geração
generate_course	scan_result, toc, target_html_path	Etapa final
scope_to_subdir	subdir_path	Monorepo grande ou foco em funcionalidade

Custo e limites

O que custa rodar

Cota de API: N/A
Tokens por chamada: Significativo — a skill lê o repositório inteiro (10k–50k tokens típico)
Monetário: Gratuito; seus tokens do modelo se aplicam
Dica: Para monorepos, use scope_to_subdir; não crie um curso do projeto inteiro de uma vez

Segurança

Permissões, segredos, alcance

Escopos mínimos: filesystem-read filesystem-write

Armazenamento de credenciais: Nenhum

Saída de dados: Nenhuma — leitura/escrita puramente local

O curso gerado pode incluir trechos de código; revise antes de compartilhar externamente se o repositório tem segredos

Solução de problemas

Erros comuns e correções

Course is too generic / doesn't reference real code

Torne o prompt mais específico; peça citações file:line

Repo too large; runs out of context

Use scope_to_subdir; faça cursos por módulo e vincule-os

HTML formatting broken

Peça à skill para validar a saída; regenere se necessário

Alternativas

Codebase to Course vs. outros

Alternativa	Quando usar	Troca
Repomix + manual prompt	Você quer controle total de como a codebase é alimentada ao Claude	Mais configuração; sem formato de saída opinativo
DocsGPT / Mintlify	Você quer documentação hospedada	Produto completamente diferente; não é HTML de arquivo único
absolutely-skilled / autodoc	Você quer documentação de API auto-gerada	Referência de API ≠ tutorial

Mais

Recursos

📖 Leia o README oficial no GitHub

🐙 Ver issues abertas

🔍 Ver todos os 400+ servidores MCP e Skills