Посібник із документації

Цей каталог відповідає за написання документації, правила посилань Mintlify і політику i18n документації.

Правила Mintlify

• Документація розміщується на Mintlify (https://docs.openclaw.ai).
• Внутрішні посилання на документацію в docs/**/*.md мають залишатися відносними від кореня без суфікса .md або .mdx (приклад: [Config](/gateway/configuration)).
• Перехресні посилання на розділи мають використовувати якорі на шляхах, відносних від кореня (приклад: [Hooks](/gateway/configuration-reference#hooks)).
• Заголовки документації мають уникати довгих тире й апострофів, оскільки генерація якорів Mintlify для них нестабільна.
• README та інша документація, що відображається в GitHub, мають зберігати абсолютні URL документації, щоб посилання працювали поза Mintlify.
• Вміст документації має залишатися узагальненим: без особистих назв пристроїв, імен хостів або локальних шляхів; використовуйте заповнювачі на кшталт user@gateway-host.

Правила вмісту документації

• Для документації, текстів інтерфейсу та списків вибору впорядковуйте сервіси/провайдерів за алфавітом, якщо розділ явно не описує порядок виконання або порядок автовиявлення.
• Узгоджуйте назви вбудованих plugin з правилами термінології plugin для всього репозиторію в кореневому AGENTS.md.

Внутрішня документація

• Довготривала приватна документація операторів належить до ~/Projects/manager/docs/.
• Локальні для репозиторію внутрішні чернетки/дзеркальні документи можуть зберігатися в ігнорованому docs/internal/.
• Ніколи не додавайте сторінки docs/internal/** до навігації docs/docs.json і не посилайтеся на них із публічної документації.
• scripts/docs-sync-publish.mjs виключає та видаляє docs/internal/** з публічного репозиторію публікації openclaw/docs, якщо сторінку пізніше примусово додадуть.
• Внутрішня документація може згадувати шляхи репозиторію, назви приватних застосунків, назви елементів 1Password та інструкції виконання, але ніколи не має містити секретних значень.

Редагування оцінної карти зрілості

taxonomy.yaml і qa/maturity-scores.yaml є вхідними джерелами; згенерована документація зрілості в docs/maturity/ є проєкціями, і її не слід редагувати вручну для оцінок, LTS, таксономії, профілю QA або таблиць доказів. scripts/qa/render-maturity-docs.ts відповідає за генерацію; використовуйте pnpm maturity:render, щоб оновити закомічену документацію, і pnpm maturity:check, щоб її перевірити. .github/workflows/maturity-scorecard.yml створює попередні перегляди артефактів і може відкривати PR зі згенерованою документацією; .github/workflows/openclaw-release-checks.yml запускає його для релізного QA. Зберігайте детерміновані дані qa-evidence.json.scorecard в артефактах GitHub Actions, якщо мейнтейнер явно не попросить про санітизовану закомічену проєкцію. Людські перевизначення мають змінювати вихідний стан у PR і пояснювати причину разом із публічними або заредагованими доказами.

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.