Публикация документации приложения
Публичный адрес
До публикации документация открывается по точному ID приложения. В поле slug можно заранее указать короткое уникальное имя из строчных латинских букв, цифр и дефисов, а затем сохранить его.
После публикации slug становится основным адресом. Старые slug перенаправляют на новый, а адрес с ID приложения продолжает работать. Кнопка открытия документации появляется после добавления хотя бы одной Markdown-страницы и доступна независимо от статуса приложения.
Что видит пользователь
Публичная документация показывает название и иконку приложения, дерево папок и Markdown-страниц, содержимое текущей страницы, переключатель языка и поиск. Аватар из общих настроек приложения используется в шапке и как favicon; без него отображается стандартная иконка.
При открытии ссылки выбирается язык кабинета или сайта, а при его отсутствии — доступный перевод. Переключение языка сохраняет текущую страницу, если у неё есть соответствующая версия.
Доступность и поиск
| Состояние приложения | Прямая ссылка с ID | Прямая ссылка со slug | Список приложений и общий поиск |
|---|---|---|---|
| Непубличное, ожидает модерации или отклонено | Работает | Не работает до публикации | Не показывается |
| Опубликовано, но скрыто из каталога | Работает | Работает | Не показывается |
| Опубликовано и видно в каталоге | Работает | Работает | Показывается |
Кнопки документации в каталоге и в управлении установленным приложением открывают текущий язык интерфейса и используют другой перевод как запасной вариант. Точный ID приложения также можно передать в MCP-поиск независимо от статуса; подробности приведены в разделе «Поиск».
Публичные страницы и другие форматы
Отдельный публичный адрес создаётся только для Markdown-страницы. PDF, DOCX, TXT, изображения и таблицы могут участвовать в поиске и помогать ассистентам, но не получают собственной страницы в боковом меню.
Пользовательский Markdown отображается безопасно: raw HTML, скрипты, iframe, обработчики событий и опасные URL не исполняются. Связанные изображения и безопасные внутренние ссылки продолжают работать.
Обновления и удаление
После открытия доступа изменения документации появляются сразу и не проходят отдельную модерацию. Единственный барьер для появления в общем каталоге и поиске — состояние и видимость самого приложения.
Документация не включается в релизы и не копируется в проекты установок. При удалении приложения удаляются его материалы и документы поискового индекса.