Облачная платформаEvolution

Подключить DeepWiki


Подключение доступно пользователю с ролью repo.admin в репозитории. Роль назначается в консоли Cloud.ru при настройке проекта.

Чтобы подключить DeepWiki:

  1. Авторизуйтесь в личном кабинете.

  2. На верхней панели слева нажмите Кнопка с изображением девяти точек и выберите Разработка → Repo.

  3. Перейти в раздел Code.

  4. В шапке репозитория нажмите Подключить DeepWiki.

  5. В открывшемся окне укажите параметры генерации:

    • язык документации;

    • тип документации — выберите brief (краткий обзор) или detailed (полное описание с примерами и деталями);

    • модель для генерации документации.

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

  6. Проверьте предложенную структуру документации. В интерфейсе доступны следующие операции:

    • добавление новых разделов;

    • удаление существующих разделов;

    • изменение порядка следования разделов (переупорядочивание).

    Примечание

    На этом этапе рекомендуется тщательно проверить состав и иерархию разделов. Последующее изменение структуры на уровне заголовков технически возможно, но требует отдельной операции и оплачивается как новый сеанс генерации. Подробнее о тарифах и методике расчета.

  7. После проверки структуры подтвердите ее.

Появится сообщение «Создаем документацию». Начинается полнотекстовая генерация документации по каждому утвержденному разделу. Это разовое платное обращение к LLM.

Процесс может занять продолжительное время. Окно настройки можно закрыть — подключение продолжится в фоновом режиме.

Прогресс подключения сохраняется автоматически. При случайном закрытии вкладки браузера или потере соединения состояние сессии не сбрасывается. При повторном открытии репозитория отображается тот этап, на котором было остановлено выполнение.

После завершения генерации в верхней панели навигации репозитория появится ссылка «Документация — DeepWiki подключен».

Обработка ошибок

Если генерация на шаге 2 или 4 завершается ошибкой, вместо перехода к следующему шагу появится сообщение об ошибке и кнопка Повторить. Повторный запуск инициирует выполнение только того шага, на котором произошел сбой. Повторная настройка параметров и подтверждение структуры не требуются.