Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://docs.wowweb.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Инструкции для AI-агентов (Claude Code, Cursor, и др.)

Этот файл содержит обязательные правила для AI-агентов, работающих с документацией WowWeb AI. Все правила должны соблюдаться при любых правках.

​
Структура проекта

Документация на Mintlify, два языка (RU и EN), полностью симметричные. 
docs.json              # Конфиг Mintlify: навигация, языки, цвета
ru/                    # Русская версия
├── index.mdx
├── getting-started/
├── billing/
├── creation/
├── editing/
├── management/
├── publishing/
├── integrations/
├── how-it-works/
├── support/
└── legal/
en/                    # English version (mirrors ru/)
images/                # Скриншоты и иллюстрации
logo/                  # Логотипы (light.svg, dark.svg)
Важно: при любых изменениях текста на русском нужно сделать симметричное изменение в английской версии (и наоборот). Не оставляй версии расходящимися.

​
Правила тона и стиля

​
Запрещено

  • Длинные тире в прозе. Используй обычную запятую, точку, или перестрой предложение. Длинное тире допустимо ТОЛЬКО в таблицах как маркер «нет/прочерк» в формате | — |.
  • Эмодзи в маркерах списков (✅ ❌ 🔄 💎 и т.п.). Используй компоненты <Card icon="..."> с иконками Font Awesome.
  • Маркетинговые штампы: «нового поколения», «революционный», «уникальный», «лучший в своём роде», «номер один», «никаких сюрпризов», «в N раз быстрее». Если факт реален, говори конкретно: «генерация занимает 60-120 секунд», а не «молниеносная скорость».
  • Капс-локом и многоточиями для эмфазы. Только нормальная пунктуация.
  • Избыточные превосходные степени («лучшее решение», «идеальный вариант»).

​
Обязательно

  • Frontmatter на каждой странице: title, description, icon. Без них страница не появится в навигации Mintlify правильно.
  • Description заполняй с SEO-перспективой. Это meta-description, попадает в выдачу Google и в JSON-LD для AI-краулеров. Включай ключевые слова естественно.
  • Лид-абзац в начале страницы с конкретными фактами в первых 1-2 предложениях. AI-краулеры берут именно эти строки как «суть страницы».
  • FAQ-блок в конце ключевых страниц через <AccordionGroup> с реальными вопросами как заголовки <Accordion title="...">. Это лучший формат для AI Overviews и цитирования через ChatGPT/Perplexity.
  • Раздел “Что дальше” / “What’s next” в конце через <CardGroup cols={2}> с релевантными ссылками. Это и UX, и внутренняя перелинковка для SEO.

​
Тон

  • Дружелюбный лид + сухая фактура. Первый абзац может быть тёплым («Создайте свой первый сайт за 2 минуты»), но дальше идут конкретные факты, числа, инструкции.
  • Обращение к читателю на «вы» в русской версии (без капитализации).
  • Английская версия: обычное «you», американский английский (color, not colour).

​
Используемые Mintlify-компоненты

В этом проекте используются следующие компоненты (не используй другие без согласования):
  • <Card title="..." icon="..." href="..."> — карточка
  • <CardGroup cols={2}> или cols={3} — сетка карточек
  • <Steps> + <Step title="..."> — пошаговые инструкции
  • <Tabs> + <Tab title="..."> — вкладки
  • <Accordion title="..."> и <AccordionGroup> — раскрывающиеся блоки и FAQ
  • <Note>, <Tip>, <Warning> — callout’ы
  • <Frame caption="..."> — обёртка для скриншотов
  • Markdown таблицы для сравнений данных
Иконки Mintlify использует Font Awesome. Полный список: fontawesome.com/icons.

​
Frontmatter — формат

Каждый .mdx файл начинается с frontmatter: 
---
title: "Название страницы"
description: "Meta-description под SEO. 100-160 символов с ключевыми словами."
icon: "имя-иконки-fontawesome"
---
title отображается в сайдбаре навигации и как H1 страницы. description идёт в <meta name="description"> и в JSON-LD. icon показывается рядом с пунктом меню в сайдбаре.

​
Работа с навигацией

Навигация задаётся в docs.json в массиве navigation.languages. Каждый язык — отдельный объект с группами и страницами. При добавлении новой страницы:
  1. Создай .mdx файл в нужной папке
  2. Создай симметричный файл в другом языке
  3. Добавь обе страницы в docs.json в соответствующие группы
  4. Без этого страница не появится в навигации
При переименовании файла:
  1. Переименуй и в ru/, и в en/
  2. Обнови путь в docs.json для обоих языков
  3. Обнови все внутренние ссылки href="/..." в других файлах

​
Работа со ссылками

Внутренние ссылки идут через язык-префикс: 
[Тарифы](/ru/billing/plans)
[Pricing](/en/billing/plans)
Не используй относительные ссылки типа [link](./other-page) — Mintlify их не поддерживает. Внешние ссылки — обычным markdown: 
[YooKassa](https://yookassa.ru)

​
Что делать перед коммитом

  1. Проверь длинные тире: команда grep -rn "—" --include="*.mdx" . — все совпадения должны быть только в строках таблиц (с символом |).
  2. Проверь симметричность языков: если правил ru/billing/plans.mdx, обнови en/billing/plans.mdx соответственно.
  3. Проверь обновление docs.json если добавлял или переименовывал страницы.
  4. Commit message в формате imperative («Update pricing», «Add FAQ to quickstart», «Fix typo in account page»).

​
Что НЕЛЬЗЯ делать без явного запроса пользователя

  • Удалять страницы. Только пользователь решает что выбрасывать.
  • Менять структуру docs.json (порядок групп, переименование разделов).
  • Изменять брендинг и цвета в docs.json.
  • Удалять FAQ-блоки на существующих страницах (это SEO-актив).
  • Переписывать страницы целиком если запрошена точечная правка.
  • Добавлять страницы со сравнениями (vs Tilda, vs Wix). По решению владельца — это идёт в блог, не в доку.
  • Добавлять how-to гайды (как создать лендинг, как написать промпт). Тоже в блог.

​
Контакты в текстах

Используй эти контакты везде где они встречаются: Важно: у платформы НЕТ публичного чата сообщества. Никогда не упоминай чат-канал в текстах. Только канал с анонсами @WowWebAI и саппорт @wowweb_support. Если в существующих файлах встретишь упоминание @wowweb_chat или фразу «community chat» — замени на канал анонсов или удали упоминание целиком.

​
Когда сомневаешься

Если запрос пользователя противоречит этим правилам — спроси уточнение, а не применяй правила автоматически. Например, если просят добавить эмодзи в список — уточни, реально ли это исключение или забыл про правило.