Просмотр документации на сайте#
Интерфейс сайта документации#
GetDocs предоставляет возможность собирать и публиковать документацию на статическом сайте (site).
Распределение продуктов по категориям на главной странице сайта выполняется автоматически. Сортировка категорий происходит по алфавиту. Названия категорий и описания продуктов задаются в Продуктовом учете.
По умолчанию сайт документации имеет несколько пространств, которые определяют стадию (stage) готовности документации:
draft — собранная документация изначально попадает в это пространство. Данная сборка позволяет получить отчет сборки и информацию об исходном репозитории документации;
approved — перевод в пространство approved означает, что документация прошла внутреннее согласование и готова к внутренней приемке и публикации;
release — перевод в пространство release означает доступность документации для пользователей.
Интерфейс release и approved пространства выглядит следующим образом:
Элемент |
Описание |
|---|---|
|
Переключение в полноэкранный режим и обратно |
|
Переключение на темную/светлую тему |
|
Обращение в техподдержку |
|
Поле ввода поискового запроса. В текущей версии реализован полнотекстовый поиск в пределах комплекта документации на продукт |
|
Выход из сервиса |
|
Сворачивание и разворачивание бокового меню |
|
Вызов AI-ассистента |
Интерфейс draft пространства имеет дополнительные кнопки для разработчика документации:
Элемент |
Описание |
|---|---|
|
Переход в Argo Workflows |
|
Подменю, в котором доступны кнопки для открытия и скачивания отчета |
|
Скачивание документации в формате PDF |
|
Информация об исходных файлах собранной документации: имя репозитория, ветки и хеш коммита (срез репозитория, из которого собрана документация). По нажатию на этот блок происходит переход в репозиторий документации для внесения исправлений |
AI-ассистент#
Для более удобного поиска по сайту можно воспользоваться AI-ассистентом. Откройте чат с ассистентом, нажав кнопку в правом нижнем углу, и введите запрос. Поиск производится с учетом текущего контекста:
когда открыта разводящая страница со всеми комплектами документации, поиск производится по всей документации:
когда открыта документация продукта, поиск производится по текущему комплекту:
