Как показывать клиентам документацию из приватного репозитория, не открывая им доступ к репозиторию
Коротко
- Портал зеркалирует выбранные Markdown-папки из приватного GitHub- или GitLab-репозитория и обновляет страницы после коммитов.
- Файлы, указанные в .docignore, не загружаются в портал и MCP-индекс, поэтому закрытые заметки нельзя получить через просмотрщик.
- Клиенты могут комментировать отдельные абзацы без аккаунта GitHub, а владельцы получают треды в едином инбоксе.
- MCP-сервер использует OAuth 2.1 с PKCE, учитывает права конкретного пользователя и разрешает AI-агентам только чтение документов.
- Сервис не редактирует исходные файлы, пока не поддерживает self-hosted-развёртывание и предлагает 30 бесплатных дней без карты.
Репозиторий подключается через GitHub или GitLab App, после чего владелец выбирает папки с Markdown-файлами. Сервис рендерит Markdown и GitHub Flavored Markdown, подсвечивает код, отображает Mermaid-диаграммы, оглавление и перекрёстные ссылки. После нового коммита страницы обновляются без отдельной сборки и деплоя.
Файл .docignore исключает документы из индекса: внутренние заметки, черновики и другие закрытые материалы не загружаются ни в портал, ни в MCP. Клиенты могут комментировать отдельные абзацы без аккаунта GitHub, а владельцы получают треды в общем инбоксе и закрывают их после обработки.
MCP-сервер работает в режиме только для чтения и использует OAuth 2.1 с PKCE: AI-агент видит только те документы, которые доступны конкретному аккаунту в браузере. Сервис не заменяет редактор, self-hosted-версия пока не доступна; бесплатный период длится 30 дней и не требует банковской карты.
FAQ
Зачем нужен отдельный портал, если документация уже хранится рядом с кодом в приватном GitHub- или GitLab-репозитории?
Он позволяет клиентам, менеджерам и другим читателям изучать и комментировать документацию без доступа к коду, регистрации в GitHub и ручного копирования файлов в Google Docs.
Как сервис не допускает AI-агента и внешнего читателя к внутренним файлам, черновикам и другим закрытым материалам проекта?
Файлы из .docignore не попадают в индекс, а OAuth 2.1 с PKCE ограничивает каждое MCP-соединение правами конкретного аккаунта.
Можно ли редактировать документацию через клиентский портал или развернуть этот сервис на собственной инфраструктуре?
Портал работает только как просмотрщик с комментариями и MCP-доступом. Редактирование выполняется в исходном репозитории, а self-hosted-версия пока только запланирована.
Читайте также
AI R&D DAY: два трека об исследованиях и продуктизации ИИ- Двенадцать граблей Gmail API, которые я собрал, пока учил Claude отправлять почту
Чтобы агентная реклама работала, нужно решить, чего ИИ никогда не должен касаться
OpenAI запускает рекламу в ChatGPT для пользователей Европы- Как собрать System Context Pack за час
- Клиентский портал поверх приватного репозитория: Документацию можно хранить рядом с кодом в Markdown, а внешним читателям показывать через отдельный портал, который зеркалирует только выбранные папки репозитория. Это сохраняет единый источник истины и исключает ручное копирование документов в Google Docs или Notion.
[Процесс: Docs as Code]
Зарегистрированные пользователи видят только два тезиса.
Зарегистрироваться
#Хабр#MCP#oauth#saas#cursor#github#documentation-culture#knowledge-management#claude-code#docs-as-code#knowledge-bases#gitlab#markdown#product-documentation#miradorly
Команда создала сервис, который показывает клиентам документацию из приватных GitHub- и GitLab-репозиториев без доступа к самому репозиторию. Портал автоматически обновляется после коммитов, поддерживает комментарии и подключение AI-агентов через Model Context Protocol.