Repo Docs
Открыть приложение: Документировать репозиторий → (products.documentize.ai)
В одном предложении
Repo Docs читает репозиторий GitHub, пишет для него сайт документации (обзор, архитектура, проекты, справочник API, диаграммы и другое) и доставляет его в виде запроса на слияние (pull request) плюс скачиваемого zip.
Чем он уникален
- Он опирается на ваш код. Сначала код индексируется, затем ИИ его объясняет. Каждое имя типа или члена, которое пишет ИИ, сверяется с этим индексом; несуществующие имена исправляются или удаляются, а отчёт о качестве перечисляет, что проверялось.
- Он заканчивается pull request, а не просто файлом. Pull request меняет только созданные файлы; рукописные документы никогда не затрагиваются.
- Его можно продолжить. Запуск, упёршийся в лимит времени, сохраняет то, что успел, а Continue доделывает остальное.
Когда использовать и когда нет
- Используйте, чтобы дать репозиторию первый настоящий комплект документации, обновить документацию после большого изменения или ввести в курс новых участников.
- Не для модели данных кода, к которой можно делать запросы → Code Graph.
- Не для одной скомпилированной библиотеки, исходников которой вы не видите → Assembly Chat.
- Не для языков вне списка. Поддерживаются: .NET (C#), TypeScript, Python, Java и Go. Остальные файлы не документируются.
Прежде чем начать
- Репозиторий GitHub в виде
owner/nameили URL (URL вида/tree/<branch>выбирает эту ветку). - Приватный репозиторий? Пригласите аккаунт GitHub
arise-projectкак соавтора; тогда pull request попадёт прямо в ваш репозиторий. Без этого, как сказано на странице, pull request открывается в собственном форкеarise-project(это работает только для репозиториев, которые он может читать; для приватного нужно приглашение). - Конфиденциальность: репозиторий копируется во временную папку на время запуска и затем удаляется. ИИ-объяснения репозитория кэшируются, чтобы последующие запуски шли быстрее; страница сообщает, что сам код не сохраняется. Фрагменты кода отправляются в языковую модель, чтобы писать объяснения, поэтому не запускайте на коде, которым вам нельзя делиться с этой службой.
Пошаговая инструкция
- Введите репозиторий GitHub и, если нужно, Ветку.
- Выберите Разделы, Аудиторию и Уровень детализации (см. ниже). Если в решении .NET их несколько, введите путь к Решению (.sln).
- Задайте Язык вывода и Папку Docs, если не хотите
docs. - Запустите. Pull request открывается рано как черновик (ссылка на него появляется в течение нескольких минут) и обновляется по ходу запуска.
- Когда запуск завершится, откройте pull request или скачайте zip. Если в результате сказано, что документация частичная, нажмите Продолжить документацию.
- Ваши запуски перечислены в разделе «Ваши репозитории» (сохраняется в этом браузере): там можно следить за ними, нажать Запустить снова или удалить.
Параметры
| Параметр | Что делает | По умолчанию | Рекомендуется |
|---|---|---|---|
| Решение (.sln), только .NET | Файл .sln, .slnx или .csproj внутри репозитория для документирования | находится автоматически | Задайте, если в репозитории несколько решений |
| Разделы | Обзор, Архитектура, Проекты, Функции, Справочник API, Диаграммы (включены); Примеры, Глоссарий (выключены) | шесть включены | Добавьте Примеры и Глоссарий для публичных библиотек |
| Аудитория | Новые участники, пользователи API или Оба | Оба | Выберите одну, чтобы сократить результат |
| Уровень детализации | Кратко, Стандарт, Тщательный | Стандарт | Кратко — для первого знакомства |
| Язык вывода | По умолчанию (английский) или один из de, fr, es, it, pt, nl, pl, ru, uk, tr, ar, hi, ja, ko, zh | английский | Выбирайте по читателям |
| Папка Docs | Папка репозитория, в которую попадёт документация (не внутри .git или .github) | docs | Оставьте по умолчанию |
| Полные сигнатуры членов | Показывает полные сигнатуры в справочнике API | включено | Оставьте включённым |
| Включить внутренние типы | Документирует и внутренние типы | выключено | Только для документации участников |
| Улучшить README | Предлагает лучший README отдельным коммитом | выключено | Попробуйте; уберите коммит, если не понравится |
Если в вашей папке документации уже лежат рукописные страницы, созданная документация вместо этого попадёт в подпапку repodocs, чтобы ничего вашего не мешало.
Что вы получите
- Pull request от
arise-project(черновик, пока документация частичная; помечается готовым к проверке при полном покрытии). Более старые pull request с документацией для прежних коммитов закрываются со ссылкой на новый. - Zip со страницами Markdown, конфигурацией MkDocs (на странице упоминается и конфигурация DocFX), сайтом HTML и PDF. Диаграммы — Mermaid: зависимости проектов, семейства компонентов и регистрации внедрения зависимостей.
- Панель результата: запланированные и готовые страницы, сколько ИИ-объяснений написано, битые ссылки и статус pull request.
Качество и ограничения
- Текст, написанный ИИ, поверх точного индекса кода. Всё строится по одному коммиту, и страница показывает, по какому.
- Бесплатный запуск останавливается через 15 минут с тем, что успел; платный план завершает документацию за один запуск.
- Запуски Continue не учитываются в квоте: код считает Continue небиллингуемым, и он должен продолжать реальный предыдущий запуск того же репозитория. Текст страницы сообщает, что Continue доделывает остальное бесплатно.
- Код никогда не собирается и не запускается.
Хорошо сочетается с
- До: Code Graph для структурной карты; NuGet Updater, чтобы зависимости были свежими.
- После: публикация результата pull request через MkDocs или GitHub Pages.
- Связанное: Доверие, проверка и ограничения результатов ИИ.
Типичные ошибки и их исправление
- Pull request — черновик → документация частичная; нажмите «Продолжить».
- Нет pull request, но есть zip → доставка не удалась (например, нет доступа). В zip та же документация.
- «Select at least one section» → отметьте хотя бы один раздел.
- Папка Docs отклонена → это должен быть относительный путь внутри репозитория.
- Задокументировано не то решение → задайте Решение (.sln) явно.
То же в других каналах
Для этого приложения не проверено. См. каналы.
Попробуйте
Запустите Repo Docs на небольшом публичном репозитории с уровнем детализации Кратко, только с разделами «Обзор» и «Архитектура» и папкой по умолчанию. Откройте черновик pull request, когда появится ссылка, прочитайте страницу архитектуры и сверьте с кодом одно упомянутое в ней имя класса.