Moxie Docs

Что такое Moxie Docs?

Moxie Docs — это система документации для репозиториев GitHub, которая автоматически генерирует и поддерживает документацию по кодовой базе. Она индексирует репозиторий, создает доступные для поиска документы по архитектуре, соглашениям и пошаговым сценариям, а затем повторно проверяет эти страницы при изменениях в коде, чтобы устаревший материал можно было пометить и переписать.

Она также предоставляет AI-инструментам, работающим через MCP, соглашения репозитория и проверенный контекст с доступом только для чтения в рамках задачи. Кроме того, она может раз в неделю открывать pull request только с изменениями документации — “Friday Cleanup” — чтобы собрать накопившиеся за неделю расхождения.

Ключевые возможности

• Непрерывное индексирование репозитория: Moxie подключается к репозиторию GitHub и поддерживает актуальный индекс по мере появления merge-коммитов, чтобы документация была привязана к последнему коду.
• Сгенерированная документация с цитатами из источников: Она создает страницы по архитектуре, соглашениям и пошаговым сценариям с ссылками на исходный код, что упрощает проверку результата.
• Обнаружение расхождений при merge: Когда изменения в коде затрагивают существующую документацию, Moxie отмечает расхождения и заново генерирует нужные страницы вместо того, чтобы оставлять их устаревшими.
• MCP-контекст для агентов: AI-инструменты, такие как Cursor, Claude Code и Codex, могут получать через MCP соглашения, документацию и проверенные команды без повторного обхода репозитория на каждом запросе.
• Pull request’ы Friday Cleanup: Раз в неделю Moxie может открывать pull request только с документацией, чтобы собрать и показать обновления документации на проверку.
• Проверки в рабочем процессе PR: Он может проверять pull request’ы на влияние на документацию и соответствие описания перед merge, оставляя изменения кода и контроль merge за командой.

Как использовать Moxie Docs

Начните с подключения репозитория GitHub. Moxie индексирует кодовую базу, создает первый набор документации и кратко описывает соглашения, которые могут использоваться людьми или AI-агентами.

Далее команды используют его двумя основными способами: просматривают документацию, которую Moxie генерирует и обновляет, и позволяют ему проверять новые pull request’ы на устаревшую документацию или несоответствие описаний. При необходимости MCP-интеграцию могут использовать кодовые агенты, чтобы получать контекст, специфичный для репозитория, в ограниченном режиме только для чтения.

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

• Поддержание актуальности архитектурной документации: Команда ведет страницы вроде поведения вебхуков или потоков биллинга, а Moxie обновляет документацию, когда появляются связанные изменения в коде.
• Передача контекста репозитория кодовым агентам: Разработчики, использующие Cursor, Claude Code или Codex, могут получать соглашения и проверенные команды без ручного просмотра репозитория.
• Еженедельная проверка расхождений в документации: Команды, которым нужен регулярный цикл очистки, могут просматривать pull request Friday Cleanup только с документацией вместо того, чтобы вручную искать устаревшие страницы.
• Проверка влияния PR перед merge: Мейнтейнеры могут увидеть, затрагивает ли pull request документацию или требует ли переписывания описания до его merge.
• Онбординг новых инженеров: Новые участники могут искать сгенерированную документацию и закладки в одном рабочем пространстве вместо чтения нескольких исходных файлов для понимания соглашений.

FAQ

Moxie автоматически меняет мой код?
Нет. В источнике указано, что изменения кода остаются под контролем команды. Обновления документации доставляются в виде pull request’ов только с документацией, пригодных для проверки, а правки согласованности описания меняют описание PR, а не код.

Что происходит после подключения репозитория?
Moxie индексирует репозиторий, генерирует доступную для поиска документацию, кратко описывает соглашения и начинает проверять новые pull request’ы на влияние на документацию и соответствие описания.

Доступ к репозиторию ограничен?
Да. В описании продукта указано, что по умолчанию доступ доступен только для чтения и ограничен конкретным репозиторием, а MCP-контекст ограничен задачей, а не всей кодовой базой.

Какие виды документации он генерирует?
На странице отдельно упоминаются страницы по архитектуре, соглашения, пошаговые сценарии и документация по темам вроде вебхуков биллинга.

Он работает только с GitHub?
Страница написана для репозиториев GitHub, поэтому здесь GitHub — поддерживаемый источник.

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

• Ручная документация в Markdown или wiki для документации: Это самый простой вариант, но он не выполняет автоматическую перепроверку документации по коду и не генерирует обновления с цитатами из исходников.
• Универсальные инструменты поиска по коду и просмотра репозиториев: Они помогают просматривать файлы, но не предоставляют поддерживаемый слой документации или PR только для очистки документации.
• Отдельные AI-ассистенты для кодинга без repo-aware документации: Они могут отвечать на вопросы и редактировать код, но всё равно полагаются на повторное обнаружение контекста моделью, если не связаны с системой вроде Moxie.
• Внутренние процессы документации, построенные вокруг pull request и ревью: Команды могут вручную управлять документацией через PR, но им приходится самим создавать и отслеживать проверки на расхождения, а не получать их, сгенерированные из кодовой базы.