/ Каталог / Песочница / Codebase to Course
● Сообщество zarazhangrui ⚡ Сразу

Codebase to Course

автор zarazhangrui · zarazhangrui/codebase-to-course

Укажи на репозиторий — получи один HTML «курс», объясняющий его как туториал: аннотированный код, диаграммы, нарратив — для не-инженеров и новых сотрудников.

codebase-to-course — это Claude Code skill, который обходит весь репозиторий и создаёт единый HTML-курс, объясняющий как кодовая база на самом деле работает. Структурирован как туториал: обзор архитектуры на высоком уровне, затем глубокое погружение по модулям, затем сквозные walkthroughs. С встроенными аннотированными фрагментами кода. Результат — один HTML-файл, без шага сборки.

Зачем использовать

Ключевые функции

Живое демо

Как выглядит на практике

готово

Установка

Выберите клиент

~/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
    }
  }
}

Откройте Claude Desktop → Settings → Developer → Edit Config. Перезапустите после сохранения.

~/.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 использует ту же схему mcpServers, что и Claude Desktop. Конфиг проекта приоритетнее глобального.

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

Щёлкните значок MCP Servers на боковой панели Cline, затем "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
    }
  }
}

Тот же формат, что и Claude Desktop. Перезапустите Windsurf для применения.

~/.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 использует массив объектов серверов, а не 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"
        ]
      }
    }
  }
}

Добавьте в context_servers. Zed перезагружается автоматически.

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

Однострочная команда. Проверить: claude mcp list. Удалить: claude mcp remove.

Сценарии использования

Реальные сценарии: Codebase to Course

Сгенерировать онбординг-курс для нового сотрудника

👤 Engineering managers / tech leads ⏱ ~45 min beginner

Когда использовать: В пятницу после принятия оффера: нужен реальный артефакт онбординга вместо «иди читай код».

Предварительные требования
  • Скилл установлен — git clone https://github.com/zarazhangrui/codebase-to-course ~/.claude/skills/codebase-to-course
  • Репозиторий склонирован — Стандартный git clone
Поток
  1. Сканировать репозиторий
    codebase-to-course: сканируй ./our-app. Сначала выведи предложенную структуру курса — список разделов — до начала написания.✓ Скопировано
    → Конкретное оглавление: архитектура, модули, потоки запросов
  2. Сгенерировать курс
    Хорошо. Сгенерируй полный HTML в /onboarding/course.html. Целевая аудитория: новый full-stack разработчик, знающий React + Node, но не нашу доменную область.✓ Скопировано
    → HTML-файл сгенерирован; открывается в браузере
  3. Проверить точность
    Spot-check: соответствует ли walkthrough «auth flow» тому что реально в src/auth/? Процитируй настоящий код.✓ Скопировано
    → Walkthrough ссылается на реальные пути файлов и актуальный код

Итог: Реальный артефакт онбординга, который сэкономит команде 2 недели объяснений.

Подводные камни
  • Курс слишком длинный для реального прочтения — Укажи максимальное число разделов; качество важнее полноты
  • Фрагменты кода устаревают — Регенерируй после крупных рефакторингов; скилл работает быстро
Сочетать с: filesystem · git-mcp-idosal

Объяснить сложную фичу нетехническому PM

👤 Tech leads ⏱ ~20 min beginner

Когда использовать: PM постоянно спрашивает «почему это занимает 3 спринта» — нужен конкретный артефакт.

Поток
  1. Сузить до фичи
    codebase-to-course: сфокусируйся на src/payments/. Аудитория: PM без инженерного бэкграунда. Больше диаграмм и аналогий, меньше кода.✓ Скопировано
    → Курс высокоуровневый; блоки кода минимальны

Итог: PM уходит с ментальной моделью.

Подводные камни
  • Аналогии излишне упрощают — Проводи spot-check; скилл предпочитает точность если его подталкивать

Сгенерировать страницу «как это работает» для open source проекта

👤 OSS-мейнтейнеры ⏱ ~30 min intermediate

Когда использовать: README описывает фичи, но нет архитектурного объяснения.

Поток
  1. Сгенерировать как страницу документации
    codebase-to-course: сканируй main branch. Выведи ARCHITECTURE.html для сайта документации. Целевая аудитория: опытные разработчики, оценивающие проект.✓ Скопировано
    → Результат читается как вдумчивое руководство контрибьютора

Итог: Лучший опыт разработчика для оценщиков и контрибьюторов.

Подводные камни
  • Курс выглядит безликим (обобщённым) — Передай название проекта + стилевые подсказки в prompt

Комбинации

Сочетайте с другими MCP — эффект x10

codebase-to-course-skill + filesystem

Читать локальный репозиторий и записывать курс

codebase-to-course: сканируй ./our-app, запиши /onboarding/course.html.✓ Скопировано
codebase-to-course-skill + git-mcp-idosal

Создать курс по внешнему репозиторию без клонирования

Используй GitMCP для owner/repo. Затем codebase-to-course поверх этого.✓ Скопировано

Инструменты

Что предоставляет этот MCP

ИнструментВходные данныеКогда вызыватьСтоимость
scan_repo path Всегда первым 0
propose_toc scan_result, audience После сканирования, до генерации 0
generate_course scan_result, toc, target_html_path Финальный шаг 0
scope_to_subdir subdir_path Большой монорепозиторий или фокус на фиче 0

Стоимость и лимиты

Во что обходится

Квота API
Н/П
Токенов на вызов
Значительные — скилл читает весь репозиторий (обычно 10k–50k токенов)
Деньги
Бесплатно; применяются твои токены модели
Совет
Для монорепозиториев используй scope_to_subdir; не создавай курс по всему сразу

Безопасность

Права, секреты, радиус поражения

Минимальные скоупы: filesystem-read filesystem-write
Хранение учётных данных: Нет
Исходящий трафик: Нет — только локальное чтение/запись

Устранение неполадок

Частые ошибки и исправления

Курс слишком обобщённый / не ссылается на реальный код

Сделай prompt более конкретным; проси цитирование file:line

Репозиторий слишком большой; контекст заканчивается

Используй scope_to_subdir; делай курсы по-модульно и линкуй их

Форматирование HTML сломано

Попроси скилл валидировать вывод; при необходимости регенерируй

Альтернативы

Codebase to Course в сравнении

АльтернативаКогда использоватьКомпромисс
Repomix + ручной promptХочешь полный контроль над тем как кодовая база передаётся ClaudeБольше настройки; нет самоуверенного формата вывода
DocsGPT / MintlifyНужна хостинговая документацияСовершенно другой продукт; не единый HTML
absolutely-skilled / autodocНужна автосгенерированная справочная документация APIAPI ref ≠ туториал

Ещё

Ресурсы

📖 Читать официальный README на GitHub

🐙 Открытые задачи

🔍 Все 400+ MCP-серверов и Skills