Skip to main content
Эта страница предназначена для сопровождающих документацию. Mintlify-корень — каталог docs/: здесь лежат docs.json, .mintignore и все MDX. Постоянные инструкции агента — в docs/AGENTS.md и .cursor/rules/mintlify-docs.mdc. Skills Mintlify лежат в .agents/skills/; MCP — в .cursor/mcp.json. Для работы с документацией вызывайте субагента mintlify-docsops (.cursor/agents/mintlify-docsops.md).
Если вы открыли каталог docs/ на GitHub, начните с README.md. Эта страница — рабочий цикл сопровождающего.
В Mintlify dashboard укажите content path /docs. Workflow .github/workflows/pages.yml собирает Astro-проект в site/ и публикует site/dist; это маркетинговый хаб lampac.dev, а не замена Mintlify.

​
Установить инструменты

В Cursor официальный Mintlify plugin уже предоставляет documentation skill, read-only Search MCP и OAuth Admin MCP. Не устанавливайте вторую копию, если эти инструменты доступны в текущем workspace.

​
Рабочий цикл

1

Обновите контекст

Сверьте текст с кодом, config/base.conf, config/example.init.*, manifest.json, compose/Helm и README модуля.
2

Измените MDX

Сохраняйте существующие slug, добавляйте keywords, используйте root-relative ссылки без префикса /docs/ и включайте новые страницы в docs/docs.json.
3

Запустите preview

4

Проверьте качество

5

Просмотрите diff

Убедитесь, что примеры не содержат credentials, внутренние ссылки открываются, а заявленные defaults совпадают с кодом.

​
Admin MCP

Write-enabled Mintlify MCP работает через OAuth и создаёт отдельную branch session:
checkout обязателен перед редакторскими операциями. Используйте save в режиме PR, чтобы изменения прошли review.
Не смешивайте независимые изменения в одной Admin MCP session. Перед save всегда проверяйте diff.

​
GitHub Pages (lampac.dev)

Маркетинговый хаб — Astro-проект в site/. Сборка в CI: Node 22, npm ci, npm run build, артефакт site/dist. Локально:
Продакшен-сборка: npm run build (выход в site/dist). Не коммитьте dist/, node_modules/ и .astro/. Пользовательские гайды остаются на этом Mintlify-сайте; лендинг на них только ссылается. Dependabot раз в неделю открывает PR на npm-зависимости в site/ (экосистема npm, каталог /site в .github/dependabot.yml).

​
DeepWiki

Публичный DeepWiki — английский code-wiki, а не Devin Enterprise и не вторая копия Mintlify. Его рулит .devin/wiki.json в корне репозитория. Лимиты публичного DeepWiki:
  • не больше 30 страниц, если задан массив pages — генерируются только они;
  • не больше 100 заметок (repo_notes + все page_notes);
  • не больше 10 000 символов на заметку;
  • заголовки страниц уникальны.
Страницы wiki зеркалят группы навигации Mintlify (docs/docs.json), а не каждый MDX-файл. Процедуры установки, таблицы API и пользовательские гайды остаются на docs.lampac.dev. DeepWiki объясняет, где тема живёт в коде, и ссылается на соответствующие URL Mintlify. Когда вы добавляете группу в навигацию docs.json, впишите её в существующую wiki-страницу или замените лист. Не добавляйте 31-ю страницу. Репозиторий не умеет пересобрать wiki. После merge в main откройте deepwiki.com/lampac-nextgen/lampac и запросите повторную индексацию вручную.

​
Что документировать

  • пользовательский результат и проверяемую процедуру;
  • реальные route names, методы и ограничения;
  • различие между base defaults, starter config и manifest state;
  • риски публичного доступа и расположение persistent data;
  • troubleshooting с конкретной командой проверки.
Не переносите README дословно: README может описывать внутреннюю реализацию, несколько языков или экспериментальные детали, которые не нужны в основном user journey.
Last modified on September 2, 2026