4.2 KiB
4.2 KiB
| x-i18n | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Посібник з документації
Цей каталог відповідає за написання документації, правила посилань 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.