|
1 | 1 | --- |
2 | 2 | x-i18n: |
3 | | - generated_at: "2026-04-12T08:47:29Z" |
| 3 | + generated_at: "2026-04-23T06:42:09Z" |
4 | 4 | model: gpt-5.4 |
5 | 5 | provider: openai |
6 | | - source_hash: 6805814012caac6ff64f17f44f393975510c5af3421fae9651ed9033e5861784 |
| 6 | + source_hash: 8b046833f9a15dc61894ab9e808a09a9fb055ef7ada5c3d4893fbe5f70dec126 |
7 | 7 | source_path: AGENTS.md |
8 | 8 | workflow: 15 |
9 | 9 | --- |
10 | 10 |
|
11 | 11 | # Посібник з документації |
12 | 12 |
|
13 | | -Цей каталог відповідає за написання документації, правила посилань Mintlify та політику i18n документації. |
| 13 | +Цей каталог відповідає за створення документації, правила посилань Mintlify та політику i18n для документації. |
14 | 14 |
|
15 | 15 | ## Правила Mintlify |
16 | 16 |
|
17 | 17 | - Документація розміщена на Mintlify (`https://docs.openclaw.ai`). |
18 | | -- Внутрішні посилання на документацію в `docs/**/*.md` мають залишатися кореневовідносними без суфікса `.md` або `.mdx` (приклад: `[Config](/configuration)`). |
19 | | -- Перехресні посилання на розділи мають використовувати якорі на кореневовідносних шляхах (приклад: `[Hooks](/configuration#hooks)`). |
| 18 | +- Внутрішні посилання на документацію в `docs/**/*.md` мають залишатися кореневими відносними без суфікса `.md` або `.mdx` (приклад: `[Config](/gateway/configuration)`). |
| 19 | +- Перехресні посилання на розділи мають використовувати якорі на кореневих відносних шляхах (приклад: `[Hooks](/gateway/configuration-reference#hooks)`). |
20 | 20 | - У заголовках документації слід уникати довгих тире та апострофів, оскільки генерація якорів у Mintlify з ними працює нестабільно. |
21 | | -- README та інші документи, що відображаються на GitHub, мають зберігати абсолютні URL документації, щоб посилання працювали поза Mintlify. |
22 | | -- Вміст документації має залишатися узагальненим: без персональних назв пристроїв, імен хостів або локальних шляхів; використовуйте заповнювачі на кшталт `user@gateway-host`. |
| 21 | +- README та інші документи, що відображаються на GitHub, мають зберігати абсолютні URL-адреси документації, щоб посилання працювали поза Mintlify. |
| 22 | +- Вміст документації має залишатися загальним: без особистих назв пристроїв, хостів або локальних шляхів; використовуйте заповнювачі на кшталт `user@gateway-host`. |
23 | 23 |
|
24 | 24 | ## Правила вмісту документації |
25 | 25 |
|
26 | | -- У документації, текстах інтерфейсу та списках вибору впорядковуйте служби/провайдерів за абеткою, якщо тільки розділ явно не описує порядок виконання або порядок автовиявлення. |
27 | | -- Підтримуйте узгоджене найменування вбудованих плагінів відповідно до загальних правил термінології плагінів у кореневому `AGENTS.md`. |
| 26 | +- У документації, текстах інтерфейсу та списках вибору сервіси/провайдери слід упорядковувати за абеткою, якщо розділ явно не описує порядок виконання або порядок автовизначення під час виконання. |
| 27 | +- Підтримуйте узгоджене найменування вбудованих plugin відповідно до загальних правил термінології plugin у кореневому `AGENTS.md`. |
28 | 28 |
|
29 | | -## i18n документації |
| 29 | +## I18n документації |
30 | 30 |
|
31 | | -- Документація іншими мовами не підтримується в цьому репозиторії. Згенерований результат публікації зберігається в окремому репозиторії `openclaw/docs` (часто локально клонованому як `../openclaw-docs`). |
32 | | -- Не додавайте і не редагуйте локалізовану документацію в `docs/<locale>/**` тут. |
33 | | -- Вважайте англомовну документацію в цьому репозиторії та файли глосарію джерелом істини. |
| 31 | +- Документація іншими мовами не підтримується в цьому репозиторії. Згенерований вивід для публікації знаходиться в окремому репозиторії `openclaw/docs` (часто локально клонованому як `../openclaw-docs`). |
| 32 | +- Не додавайте та не редагуйте локалізовану документацію в `docs/<locale>/**` тут. |
| 33 | +- Вважайте англомовну документацію в цьому репозиторії разом із файлами глосарію єдиним джерелом істини. |
34 | 34 | - Конвеєр: оновіть англомовну документацію тут, за потреби оновіть `docs/.i18n/glossary.<locale>.json`, а потім дозвольте синхронізації репозиторію публікації та `scripts/docs-i18n` виконатися в `openclaw/docs`. |
35 | | -- Перед повторним запуском `scripts/docs-i18n` додайте записи до глосарію для будь-яких нових технічних термінів, назв сторінок або коротких навігаційних міток, які мають залишатися англійською або мати фіксований переклад. |
36 | | -- `pnpm docs:check-i18n-glossary` — це перевірка для змінених англомовних заголовків документації та коротких внутрішніх міток документації. |
37 | | -- Пам’ять перекладів зберігається у згенерованих файлах `docs/.i18n/*.tm.jsonl` у репозиторії публікації. |
| 35 | +- Перед повторним запуском `scripts/docs-i18n` додайте записи до глосарію для будь-яких нових технічних термінів, заголовків сторінок або коротких навігаційних міток, які мають залишатися англійською або мати фіксований переклад. |
| 36 | +- `pnpm docs:check-i18n-glossary` є перевіркою для змінених англомовних заголовків документації та коротких внутрішніх міток документації. |
| 37 | +- Пам’ять перекладу зберігається у згенерованих файлах `docs/.i18n/*.tm.jsonl` у репозиторії публікації. |
38 | 38 | - Див. `docs/.i18n/README.md`. |
0 commit comments