docs: add Voice & Style guide and rewrite docs pages to match
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:
@@ -5,7 +5,7 @@ description: Przewodnik konfiguracji i obsługi OpenChamber w przeglądarce, na
|
||||
|
||||
# Dokumentacja OpenChamber
|
||||
|
||||
OpenChamber to wizualna przestrzeń pracy wokół OpenCode.
|
||||
OpenChamber to wizualna przestrzeń pracy wokół OpenCode (agenta AI do programowania, który działa w terminalu). Daje Ci ekran, na którym możesz obserwować i kierować tą pracą, zamiast pozostawać w wierszu poleceń.
|
||||
|
||||
Skorzystaj z tej dokumentacji, aby:
|
||||
|
||||
|
||||
@@ -5,15 +5,15 @@ description: Zainstaluj OpenChamber na komputer, do przeglądarki lub do VS Code
|
||||
|
||||
# Instalacja
|
||||
|
||||
OpenChamber ma trzy główne platformy:
|
||||
OpenChamber można uruchomić na trzy sposoby:
|
||||
|
||||
- aplikacja na komputer dla macOS
|
||||
- aplikacja webowa hostowana przez CLI z instalowalnym PWA
|
||||
- aplikacja webowa hostowana przez CLI, którą możesz zainstalować jak aplikację na telefonie (jako PWA)
|
||||
- rozszerzenie do VS Code
|
||||
|
||||
## Wymaganie wstępne
|
||||
|
||||
Najpierw zainstaluj [OpenCode](https://opencode.ai).
|
||||
Najpierw zainstaluj [OpenCode](https://opencode.ai) — OpenChamber działa na jego bazie.
|
||||
|
||||
## Przeglądarka + PWA
|
||||
|
||||
@@ -22,12 +22,12 @@ curl -fsSL https://raw.githubusercontent.com/openchamber/openchamber/main/script
|
||||
openchamber --ui-password be-creative-here
|
||||
```
|
||||
|
||||
Następnie otwórz adres URL wypisany przez CLI (zwykle `http://localhost:3000`).
|
||||
Otwórz adres URL wypisany przez CLI (zwykle `http://localhost:3000`). Powinna pojawić się lista sesji OpenChamber. Aby mieć ją zawsze pod ręką, użyj opcji „Zainstaluj” w pasku adresu przeglądarki, aby dodać ją jako aplikację.
|
||||
|
||||
## Komputer
|
||||
|
||||
Pobierz najnowszą kompilację na komputer ze strony wydań na GitHubie lub ze strony pobierania OpenChamber.
|
||||
Pobierz najnowszą kompilację na komputer ze strony wydań na GitHubie lub ze strony pobierania OpenChamber. Otwórz ją i zaloguj się do swojego zwykłego procesu pracy OpenCode.
|
||||
|
||||
## VS Code
|
||||
|
||||
Zainstaluj z VS Code Marketplace i zaloguj się do swojego zwykłego procesu pracy OpenCode.
|
||||
Zainstaluj z VS Code Marketplace i zaloguj się do swojego zwykłego procesu pracy OpenCode. Widok OpenChamber otworzy się wtedy na pasku bocznym.
|
||||
|
||||
@@ -7,16 +7,20 @@ description: Szybko uruchom OpenChamber i wybierz platformę odpowiednią do zad
|
||||
|
||||
## Najszybsza droga
|
||||
|
||||
1. Zainstaluj OpenCode.
|
||||
2. Zainstaluj CLI OpenChamber.
|
||||
1. Zainstaluj [OpenCode](https://opencode.ai).
|
||||
2. Zainstaluj CLI OpenChamber (jednowierszowe polecenie znajdziesz w sekcji [Instalacja](/pl/install/)).
|
||||
3. Uruchom `openchamber --ui-password be-creative-here`.
|
||||
4. Otwórz webowy interfejs na swoim komputerze.
|
||||
5. W razie potrzeby uruchom tunel i zeskanuj kod QR telefonem.
|
||||
4. Otwórz adres URL wypisany przez CLI (zwykle `http://localhost:3000`).
|
||||
5. Aby korzystać z telefonu, uruchom [tunel](/pl/tunnels/) i zeskanuj kod QR.
|
||||
|
||||
Używaj silnego hasła UI, zwłaszcza jeśli planujesz udostępniać instancję zdalnie.
|
||||
W przeglądarce powinna pojawić się lista sesji OpenChamber. Jeśli się załadowała, wszystko działa.
|
||||
|
||||
Używaj silnego hasła UI, zwłaszcza jeśli planujesz udostępnić instancję w internecie.
|
||||
|
||||
Jeśli strona się nie ładuje, zajrzyj do [Rozwiązywania problemów](/pl/troubleshooting/).
|
||||
|
||||
## Której platformy użyć?
|
||||
|
||||
- użyj **komputera** do codziennej pracy w procesach skupionych na macOS
|
||||
- użyj **komputera** do codziennej pracy na macOS
|
||||
- użyj **przeglądarki** do zdalnego dostępu i przeglądania na telefonie
|
||||
- użyj **VS Code** do sesji natywnych dla edytora, obok kodu
|
||||
- użyj **VS Code** do sesji tuż obok Twojego kodu
|
||||
|
||||
@@ -17,7 +17,7 @@ mkdir -p ~/.config/openchamber/themes
|
||||
|
||||
2. Dodaj swój plik JSON do tego katalogu (na przykład `my-theme.json`).
|
||||
3. Otwórz OpenChamber, a następnie przejdź do **Settings -> Theme -> Reload themes**.
|
||||
4. Wybierz swój motyw z listy rozwijanej.
|
||||
4. Wybierz swój motyw z listy rozwijanej. Zostanie zastosowany od razu.
|
||||
|
||||
## Lokalizacja motywów
|
||||
|
||||
|
||||
@@ -5,6 +5,8 @@ description: Typowe problemy z konfiguracją i działaniem oraz szybkie rozwiąz
|
||||
|
||||
# Rozwiązywanie problemów
|
||||
|
||||
Coś poszło nie tak? Znajdź poniżej swój objaw i wypróbuj rozwiązanie.
|
||||
|
||||
## Polecenie OpenChamber kończy się lub nie uruchamia
|
||||
|
||||
- upewnij się, że Node.js `>=20`
|
||||
@@ -23,8 +25,16 @@ description: Typowe problemy z konfiguracją i działaniem oraz szybkie rozwiąz
|
||||
- zrestartuj tunel z tej samej instancji/portu
|
||||
- wygeneruj nowy link połączenia, jeśli poprzedni token został już użyty
|
||||
|
||||
Pełną konfigurację znajdziesz w [Tunele](/pl/tunnels/), a jeśli używasz proxy — w [Reverse proxy](/pl/reverse-proxy/).
|
||||
|
||||
## Rozszerzenie VS Code nie łączy się
|
||||
|
||||
- upewnij się, że serwer OpenChamber działa
|
||||
- zweryfikuj, że rozszerzenie jest zaktualizowane
|
||||
- przeładuj okno VS Code i ponów połączenie
|
||||
|
||||
## Powiązane
|
||||
|
||||
- [Szybki start](/pl/quickstart/)
|
||||
- [Tunele](/pl/tunnels/)
|
||||
- [Reverse proxy](/pl/reverse-proxy/)
|
||||
|
||||
@@ -5,7 +5,7 @@ description: Bezpiecznie udostępnij OpenChamber do dostępu zdalnego i mobilneg
|
||||
|
||||
# Tunele
|
||||
|
||||
Użyj `openchamber tunnel`, aby udostępnić działającą instancję OpenChamber.
|
||||
Tunel to publiczny link do Twojego OpenChamber, dzięki któremu możesz dotrzeć do niego z telefonu lub z innej sieci. Użyj `openchamber tunnel`, aby utworzyć go dla działającej instancji.
|
||||
|
||||
## Szybki start (tryb szybki Cloudflare)
|
||||
|
||||
@@ -27,6 +27,8 @@ openchamber tunnel start --provider cloudflare --mode quick
|
||||
openchamber tunnel status
|
||||
```
|
||||
|
||||
Gdy tunel działa, `status` pokazuje publiczny adres URL. Otwórz go lub zeskanuj kod QR, aby dotrzeć do OpenChamber z dowolnego miejsca.
|
||||
|
||||
Domyślnie OpenChamber wypisuje kod QR w interaktywnych sesjach TTY. Użyj `--qr`, aby wymusić wyświetlenie kodu QR, lub `--no-qr`, aby je wyłączyć.
|
||||
|
||||
## Tryby zarządzane
|
||||
@@ -75,3 +77,7 @@ openchamber tunnel stop --port 3000
|
||||
- jeden aktywny tunel na instancję OpenChamber (port)
|
||||
- uruchomienie nowego trybu/dostawcy na tej samej instancji zastępuje poprzedni tunel
|
||||
- wygenerowanie nowego linku połączenia unieważnia poprzedni nieużyty
|
||||
|
||||
## Powiązane
|
||||
|
||||
- [Rozwiązywanie problemów](/pl/troubleshooting/) — jeśli link tunelu nie działa
|
||||
|
||||
Reference in New Issue
Block a user