Публичный центр помощи

Центр помощи превращает опубликованные статьи базы знаний в публичный сайт с навигацией, поиском, отзывами о статьях и собственной картой сайта. Настраивается он в разделе База знаний → Центр помощи.

У каждого центра помощи есть постоянный адрес вида https://getmybot.dev/help/{ключ}, где {ключ} – непрозрачный публичный ключ бота. Позже можно добавить собственный домен вроде help.example.com, постоянный адрес при этом продолжит работать.

Что попадает на сайт

Всё решает состояние статьи:

  • Опубликовано – видна на сайте и в его поиске.
  • Внутренняя – доступна только AI-агенту. Она не появляется ни на сайте, ни в поиске, ни в карте сайта, ни в метаданных страниц.
  • Черновик – не публикуется нигде и не участвует даже во внутреннем поиске.

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

Запрос несуществующей статьи и запрос закрытой статьи дают одинаковый ответ, поэтому по сайту нельзя проверить, какие внутренние заголовки существуют.

Оформление и языки

  • Название центра помощи и логотип (изображение до 2 МБ).
  • Акцентный цвет – только hex-значение вида #2f6df6, используется для ссылок и основных действий. Произвольный CSS не принимается.
  • Доступные языки и язык по умолчанию. Посетитель может переключать язык; запрос языка, которого нет, отдаёт язык по умолчанию.
  • Ссылка на чат поддержки – адрес за кнопкой «Написать в поддержку». Принимаются только адреса https://.
  • Включить публичный центр помощи – общий выключатель. Пока он выключен, публичные маршруты не отдают ничего.

Поиск и отзывы

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

Под каждой статьёй посетитель отвечает на вопрос «Эта статья была полезной?». Один посетитель голосует по статье один раз: сайт ставит для этого подписанную cookie с флагом HttpOnly, принимает голос только со своих страниц и ограничивает частоту отправки. Голоса считаются по статьям и уходят в аналитику базы знаний, посетителям они не показываются.

Поисковые системы

Переключатель Разрешить поисковым системам индексировать центр помощи управляет robots.txt и картой сайта:

  • Включён: robots.txt разрешает обход и указывает на /help/{ключ}/sitemap.xml, где перечислены главная страница каждого включённого языка и все опубликованные статьи с датой последнего изменения.
  • Выключен: robots.txt запрещает всё, а карта сайта пуста.

Значение читается в момент запроса, ответ не кэшируется, поэтому отключение индексации срабатывает сразу. Внутренние статьи и черновики не попадают ни в карту сайта, ни в метаданные страниц.

Собственный домен

Подключение домена – это две DNS-записи.

  1. Введите адрес (например help.example.com) в блоке Собственный домен. Имя приводится к ASCII-форме; IP-адреса, localhost, маски вида *. и голые публичные суффиксы (example.co.uk) отклоняются.
  2. Интерфейс показывает две записи, которые должны существовать одновременно:
    • TXT на этом имени со значением mybot-help=<токен>;
    • CNAME с этого имени на хост приложения.
  3. Нажмите Проверить DNS. Проверка требует точного значения TXT и того, чтобы домен действительно резолвился в хост приложения.

Значение TXT показывается один раз, сразу после добавления домена, и хранится только в этом браузере. Если оно потеряно, удалите домен и добавьте заново, чтобы получить новое.

Статусы домена: Ожидает проверки, Проверен, Активен, Проверка не прошла, Отключён. У неудачной проверки сохраняется причина:

  • Значение TXT не совпадает с выданным – опубликован другой или устаревший токен.
  • TXT-запись не найдена в DNS – записи нет или она ещё не разошлась. Изменения DNS вступают в силу до 24 часов.
  • Домен не указывает на нужный адрес – CNAME (или A-записи) ведут в другое место.

HTTPS, маршрутизация и отключение

Сертификат выпускается по требованию и только для имени, которое сейчас активно у включённого центра помощи: веб-сервер спрашивает об этом API перед каждым выпуском. Непроверенное или отключённое имя сертификат не получит.

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

Отключить выключает и публичный маршрут, и выпуск сертификата, сохраняя саму запись. Отключённый домен нельзя проверить повторно: удалите его и добавьте заново, чтобы получить новое значение TXT. Удалить стирает запись полностью.

Связанные материалы