BuzzbeeSCD/openchamber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add Voice & Style guide and rewrite docs pages to match

Browse Source 
Add a Voice & Style section to the docs authoring guide, then bring every
docs page in line with it: lead with the task, add success signals to
procedures, explain jargon on first use, keep bullet casing consistent,
and link out to Troubleshooting where steps can fail.

Applied across English source and all localized versions (uk, zh-cn, es,
pt-br, ko, pl).
This commit is contained in:
Bohdan Triapitsyn
2026-05-23 02:43:34 +03:00
parent 7c0562fa4f
commit ca33c6ae57
43 changed files with 352 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/docs/content/docs/uk/index.mdx
+2 -2
View File
@@ -5,11 +5,11 @@ description: Посібник з налаштування та роботи з O
# Документація OpenChamber
OpenChamber — це візуальний робочий простір навколо OpenCode.
OpenChamber — це візуальний робочий простір навколо OpenCode (AI-агента для кодингу, який працює у вашому терміналі). Він дає екран, де можна спостерігати за цією роботою та керувати нею, замість того щоб лишатися в командному рядку.
Використовуйте ці доки, щоб:
- встановити платформу, що пасує вашому робочому процесу
- встановити застосунок, що пасує вашому робочому процесу
- безпечно відкрити OpenChamber для віддаленого використання
- налаштувати вигляд і усувати типові проблеми
packages/docs/content/docs/uk/install.mdx
+6 -6
View File
@@ -5,15 +5,15 @@ description: Встановіть OpenChamber для десктопа, вебу
# Встановлення
OpenChamber має три основні платформи:
Є три способи запустити OpenChamber:
- десктоп-застосунок для macOS
- вебзастосунок на базі CLI зі встановлюваним PWA
- вебзастосунок на базі CLI, який можна встановити як застосунок на телефоні (PWA)
- розширення для VS Code
## Передумова
Спершу встановіть [OpenCode](https://opencode.ai).
Спершу встановіть [OpenCode](https://opencode.ai) — OpenChamber працює поверх нього.
## Веб + PWA
@@ -22,12 +22,12 @@ curl -fsSL https://raw.githubusercontent.com/openchamber/openchamber/main/script
openchamber --ui-password be-creative-here
```
Потім відкрийте URL, який вивів CLI (зазвичай `http://localhost:3000`).
Відкрийте URL, який вивів CLI (зазвичай `http://localhost:3000`). Ви маєте побачити список сесій OpenChamber. Щоб він був під рукою, скористайтеся опцією «Install» в адресному рядку браузера й додайте його як застосунок.
## Десктоп
Завантажте найновішу десктопну збірку зі сторінки релізів на GitHub або зі сторінки завантаження OpenChamber.
Завантажте найновішу десктопну збірку зі сторінки релізів на GitHub або зі сторінки завантаження OpenChamber. Відкрийте її та увійдіть у свій звичний робочий процес OpenCode.
## VS Code
Встановіть із VS Code Marketplace і увійдіть у свій звичний робочий процес OpenCode.
Встановіть із VS Code Marketplace і увійдіть у свій звичний робочий процес OpenCode. Після цього вікно OpenChamber відкриється на бічній панелі.
packages/docs/content/docs/uk/quickstart.mdx
+12 -8
View File
@@ -7,16 +7,20 @@ description: Швидко запустіть OpenChamber і оберіть пл
## Найшвидший шлях
1. Встановіть OpenCode.
2. Встановіть CLI OpenChamber.
1. Встановіть [OpenCode](https://opencode.ai).
2. Встановіть CLI OpenChamber (команду в один рядок дивіться в [Встановленні](/uk/install/)).
3. Виконайте `openchamber --ui-password be-creative-here`.
4. Відкрийте веб-UI на своїй машині.
5. За потреби запустіть тунель і відскануйте QR-код із телефона.
4. Відкрийте URL, який вивів CLI (зазвичай `http://localhost:3000`).
5. Щоб користуватися з телефона, запустіть [тунель](/uk/tunnels/) і відскануйте QR-код.
Використовуйте надійний пароль UI, особливо якщо плануєте відкривати інстанс віддалено.
У браузері ви маєте побачити список сесій OpenChamber. Якщо він завантажився — все працює.
Використовуйте надійний пароль UI, особливо якщо плануєте відкривати доступ до інстансу з інтернету.
Якщо сторінка не завантажується, перегляньте [Усунення несправностей](/uk/troubleshooting/).
## Яку платформу обрати?
- обирайте **десктоп** для щоденної роботи переважно на macOS
- обирайте **веб** для віддаленого доступу та перегляду з мобільного
- обирайте **VS Code** для сесій усередині редактора, поруч із кодом
- обирайте **десктоп** для щоденної роботи на macOS
- обирайте **веб** для віддаленого доступу та перегляду з телефона
- обирайте **VS Code** для сесій поруч із вашим кодом
packages/docs/content/docs/uk/themes.mdx
+1 -1
View File
@@ -17,7 +17,7 @@ mkdir -p ~/.config/openchamber/themes
2. Додайте свій JSON-файл у цю директорію (наприклад, `my-theme.json`).
3. Відкрийте OpenChamber, потім перейдіть до **Settings -> Theme -> Reload themes**.
4. Оберіть свою тему зі спадного списку.
4. Оберіть свою тему зі спадного списку. Вона застосується одразу.
## Розташування тем
packages/docs/content/docs/uk/troubleshooting.mdx
+10
View File
@@ -5,6 +5,8 @@ description: Типові проблеми з налаштуванням і за
# Усунення несправностей
Щось пішло не так? Знайдіть свою проблему нижче і спробуйте рішення.
## Команда OpenChamber завершується або не запускається
- переконайтеся, що Node.js `>=20`
@@ -23,8 +25,16 @@ description: Типові проблеми з налаштуванням і за
- перезапустіть тунель із того самого інстансу/порту
- згенеруйте нове посилання для підключення, якщо попередній токен уже було використано
Докладне налаштування див. у розділі [Тунелі](/uk/tunnels/), а якщо ви використовуєте проксі — [Зворотний проксі](/uk/reverse-proxy/).
## Розширення VS Code не підключається
- переконайтеся, що сервер OpenChamber запущено
- перевірте, що розширення оновлено
- перезавантажте вікно VS Code і повторіть підключення
## Пов’язане
- [Швидкий старт](/uk/quickstart/)
- [Тунелі](/uk/tunnels/)
- [Зворотний проксі](/uk/reverse-proxy/)
packages/docs/content/docs/uk/tunnels.mdx
+7 -1
View File
@@ -5,7 +5,7 @@ description: Безпечно відкрийте OpenChamber для віддал
# Тунелі
Використовуйте `openchamber tunnel`, щоб відкрити запущений інстанс OpenChamber.
Тунель — це публічне посилання на ваш OpenChamber, щоб дістатися до нього з телефона чи з іншої мережі. Скористайтеся `openchamber tunnel`, щоб створити його для запущеного інстансу.
## Швидкий старт (швидкий режим Cloudflare)
@@ -27,6 +27,8 @@ openchamber tunnel start --provider cloudflare --mode quick
openchamber tunnel status
```
Коли тунель піднято, `status` показує публічний URL. Відкрийте його або відскануйте QR-код, щоб дістатися до OpenChamber звідусіль.
Типово OpenChamber виводить QR-код в інтерактивних TTY-сесіях. Використовуйте `--qr`, щоб примусово вивести QR, або `--no-qr`, щоб вимкнути його.
## Керовані режими
@@ -75,3 +77,7 @@ openchamber tunnel stop --port 3000
- один активний тунель на інстанс OpenChamber (порт)
- запуск нового режиму/провайдера на тому самому інстансі замінює попередній тунель
- генерація нового посилання для підключення відкликає попереднє невикористане
## Пов'язане
- [Усунення несправностей](/uk/troubleshooting/) — якщо посилання тунелю не працює