39 lines
4.2 KiB
Markdown
39 lines
4.2 KiB
Markdown
---
|
||
x-i18n:
|
||
generated_at: "2026-04-12T08:47:29Z"
|
||
model: gpt-5.4
|
||
provider: openai
|
||
source_hash: 6805814012caac6ff64f17f44f393975510c5af3421fae9651ed9033e5861784
|
||
source_path: AGENTS.md
|
||
workflow: 15
|
||
---
|
||
|
||
# Посібник з документації
|
||
|
||
Цей каталог відповідає за написання документації, правила посилань Mintlify та політику i18n документації.
|
||
|
||
## Правила Mintlify
|
||
|
||
- Документація розміщена на Mintlify (`https://docs.openclaw.ai`).
|
||
- Внутрішні посилання на документацію в `docs/**/*.md` мають залишатися кореневовідносними без суфікса `.md` або `.mdx` (приклад: `[Config](/configuration)`).
|
||
- Перехресні посилання на розділи мають використовувати якорі на кореневовідносних шляхах (приклад: `[Hooks](/configuration#hooks)`).
|
||
- У заголовках документації слід уникати довгих тире та апострофів, оскільки генерація якорів у Mintlify з ними працює нестабільно.
|
||
- README та інші документи, що відображаються на GitHub, мають зберігати абсолютні URL документації, щоб посилання працювали поза Mintlify.
|
||
- Вміст документації має залишатися узагальненим: без персональних назв пристроїв, імен хостів або локальних шляхів; використовуйте заповнювачі на кшталт `user@gateway-host`.
|
||
|
||
## Правила вмісту документації
|
||
|
||
- У документації, текстах інтерфейсу та списках вибору впорядковуйте служби/провайдерів за абеткою, якщо тільки розділ явно не описує порядок виконання або порядок автовиявлення.
|
||
- Підтримуйте узгоджене найменування вбудованих плагінів відповідно до загальних правил термінології плагінів у кореневому `AGENTS.md`.
|
||
|
||
## i18n документації
|
||
|
||
- Документація іншими мовами не підтримується в цьому репозиторії. Згенерований результат публікації зберігається в окремому репозиторії `openclaw/docs` (часто локально клонованому як `../openclaw-docs`).
|
||
- Не додавайте і не редагуйте локалізовану документацію в `docs/<locale>/**` тут.
|
||
- Вважайте англомовну документацію в цьому репозиторії та файли глосарію джерелом істини.
|
||
- Конвеєр: оновіть англомовну документацію тут, за потреби оновіть `docs/.i18n/glossary.<locale>.json`, а потім дозвольте синхронізації репозиторію публікації та `scripts/docs-i18n` виконатися в `openclaw/docs`.
|
||
- Перед повторним запуском `scripts/docs-i18n` додайте записи до глосарію для будь-яких нових технічних термінів, назв сторінок або коротких навігаційних міток, які мають залишатися англійською або мати фіксований переклад.
|
||
- `pnpm docs:check-i18n-glossary` — це перевірка для змінених англомовних заголовків документації та коротких внутрішніх міток документації.
|
||
- Пам’ять перекладів зберігається у згенерованих файлах `docs/.i18n/*.tm.jsonl` у репозиторії публікації.
|
||
- Див. `docs/.i18n/README.md`.
|