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

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

Правила Mintlify

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

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

• У документації, текстах інтерфейсу та списках вибору впорядковуйте служби й постачальників за абеткою, якщо розділ явно не описує порядок виконання або порядок автоматичного виявлення.
• Назви вбудованих плагінів мають відповідати загальним правилам термінології плагінів для всього репозиторію в кореневому AGENTS.md.
• Згенеровану документацію ніколи не редагуйте вручну: docs/plugins/reference/**, docs/plugins/reference.md і docs/plugins/plugin-inventory.md створюються командою pnpm plugins:inventory:gen; docs/docs_map.md — командою pnpm docs:map:gen; docs/maturity/** — командою pnpm maturity:render.

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

• Довгострокова приватна документація для операторів має зберігатися в ~/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 створює попередні перегляди артефактів і може відкривати запити на злиття зі згенерованою документацією; .github/workflows/openclaw-release-checks.yml запускає його для перевірки якості випуску. Зберігайте детерміновані дані qa-evidence.json.scorecard в артефактах GitHub Actions, якщо супроводжувач явно не попросить зафіксувати в репозиторії очищену проєкцію. Ручні перевизначення мають змінювати стан джерела в запиті на злиття та пояснювати причину разом із публічними або заредагованими доказами.

Інтернаціоналізація документації

• Документація іноземними мовами не підтримується в цьому репозиторії. Згенерований результат публікації міститься в окремому репозиторії 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.