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:
Bohdan Triapitsyn
@@ -5,12 +5,12 @@ description: 웹, 데스크톱, VS Code에서 OpenChamber를 설정하고 운영
|
||||
|
||||
# OpenChamber 문서
|
||||
|
||||
OpenChamber는 OpenCode를 둘러싼 시각적 작업 공간입니다.
|
||||
OpenChamber는 OpenCode(터미널에서 실행되는 AI 코딩 에이전트)를 둘러싼 시각적 작업 공간입니다. 명령줄에 머무르는 대신, 그 작업을 지켜보고 조율할 수 있는 화면을 제공합니다.
|
||||
|
||||
이 문서를 사용해:
|
||||
|
||||
- 워크플로에 맞는 플랫폼을 설치하세요
|
||||
- 원격 사용을 위해 OpenChamber를 안전하게 공개하세요
|
||||
- 작업 방식에 맞는 앱을 설치하세요
|
||||
- 안전한 원격 사용을 위해 OpenChamber를 여세요
|
||||
- 외관을 맞춤 설정하고 흔한 문제를 해결하세요
|
||||
|
||||
## 먼저 읽어보기
|
||||
|
||||
@@ -5,15 +5,15 @@ description: 데스크톱, 웹, VS Code용 OpenChamber를 설치하세요.
|
||||
|
||||
# 설치
|
||||
|
||||
OpenChamber에는 세 가지 주요 플랫폼이 있습니다:
|
||||
OpenChamber를 실행하는 방법은 세 가지입니다:
|
||||
|
||||
- macOS용 데스크톱 앱
|
||||
- 설치 가능한 PWA를 갖춘 CLI 호스팅 웹 앱
|
||||
- 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
|
||||
```
|
||||
|
||||
그런 다음 CLI가 출력한 URL을 여세요(보통 `http://localhost:3000`).
|
||||
CLI가 출력한 URL을 여세요(보통 `http://localhost:3000`). OpenChamber 세션 목록이 보일 것입니다. 자주 사용하려면 브라우저 주소창의 "설치" 옵션으로 앱처럼 추가하세요.
|
||||
|
||||
## 데스크톱
|
||||
|
||||
GitHub 릴리스 페이지 또는 OpenChamber 다운로드 페이지에서 최신 데스크톱 빌드를 내려받으세요.
|
||||
GitHub 릴리스 페이지 또는 OpenChamber 다운로드 페이지에서 최신 데스크톱 빌드를 내려받으세요. 실행한 뒤 평소 사용하는 OpenCode 워크플로로 로그인하세요.
|
||||
|
||||
## VS Code
|
||||
|
||||
VS Code 마켓플레이스에서 설치하고 평소 사용하는 OpenCode 워크플로로 로그인하세요.
|
||||
VS Code 마켓플레이스에서 설치하고 평소 사용하는 OpenCode 워크플로로 로그인하세요. 그러면 사이드바에 OpenChamber 뷰가 열립니다.
|
||||
|
||||
@@ -1,22 +1,26 @@
|
||||
---
|
||||
title: 빠른 시작
|
||||
description: OpenChamber를 빠르게 시작하고 작업에 맞는 플랫폼을 선택하세요.
|
||||
description: OpenChamber를 빠르게 시작하고 작업에 맞는 앱을 선택하세요.
|
||||
---
|
||||
|
||||
# 빠른 시작
|
||||
|
||||
## 가장 빠른 경로
|
||||
|
||||
1. OpenCode를 설치합니다.
|
||||
2. OpenChamber CLI를 설치합니다.
|
||||
1. [OpenCode](https://opencode.ai)를 설치합니다.
|
||||
2. OpenChamber CLI를 설치합니다(한 줄 명령은 [설치](/ko/install/)를 참고하세요).
|
||||
3. `openchamber --ui-password be-creative-here`를 실행합니다.
|
||||
4. 컴퓨터에서 웹 UI를 엽니다.
|
||||
5. 필요하면 터널을 시작하고 휴대폰으로 QR 코드를 스캔합니다.
|
||||
4. CLI가 출력한 URL을 엽니다(보통 `http://localhost:3000`).
|
||||
5. 휴대폰에서 사용하려면 [터널](/ko/tunnels/)을 시작하고 QR 코드를 스캔합니다.
|
||||
|
||||
특히 인스턴스를 원격으로 공개할 계획이라면 강력한 UI 비밀번호를 사용하세요.
|
||||
브라우저에 OpenChamber 세션 목록이 보일 것입니다. 화면이 뜨면 정상적으로 실행된 것입니다.
|
||||
|
||||
## 어떤 플랫폼을 사용해야 하나요?
|
||||
특히 인스턴스를 인터넷에 공개할 계획이라면 강력한 UI 비밀번호를 사용하세요.
|
||||
|
||||
- macOS 중심의 일상 작업에는 **데스크톱**을 사용하세요
|
||||
- 원격 접근과 모바일 검토에는 **웹**을 사용하세요
|
||||
- 코드 옆에서 에디터 네이티브 세션을 원하면 **VS Code**를 사용하세요
|
||||
페이지가 열리지 않으면 [문제 해결](/ko/troubleshooting/)을 확인하세요.
|
||||
|
||||
## 어떤 앱을 사용해야 하나요?
|
||||
|
||||
- macOS에서의 일상 작업에는 **데스크톱**을 사용하세요
|
||||
- 원격 접근과 휴대폰 검토에는 **웹**을 사용하세요
|
||||
- 코드 바로 옆에서 작업하는 세션에는 **VS Code**를 사용하세요
|
||||
|
||||
@@ -17,7 +17,7 @@ mkdir -p ~/.config/openchamber/themes
|
||||
|
||||
2. 해당 디렉터리에 JSON 파일을 추가합니다(예: `my-theme.json`).
|
||||
3. OpenChamber를 열고 **Settings -> Theme -> Reload themes**로 이동합니다.
|
||||
4. 드롭다운에서 테마를 선택합니다.
|
||||
4. 드롭다운에서 테마를 선택합니다. 곧바로 적용됩니다.
|
||||
|
||||
## 테마 위치
|
||||
|
||||
|
||||
@@ -5,6 +5,8 @@ description: 흔한 설정 및 실행 문제와 빠른 해결 방법.
|
||||
|
||||
# 문제 해결
|
||||
|
||||
문제가 생겼나요? 아래에서 증상을 찾아 해결 방법을 시도해 보세요.
|
||||
|
||||
## OpenChamber 명령이 종료되거나 시작되지 않음
|
||||
|
||||
- Node.js `>=20`인지 확인하세요
|
||||
@@ -23,8 +25,16 @@ description: 흔한 설정 및 실행 문제와 빠른 해결 방법.
|
||||
- 같은 인스턴스/포트에서 터널을 다시 시작하세요
|
||||
- 이전 토큰이 이미 사용되었다면 연결 링크를 다시 생성하세요
|
||||
|
||||
전체 설정은 [터널](/ko/tunnels/)을, 리버스 프록시를 사용한다면 [리버스 프록시](/ko/reverse-proxy/)를 참고하세요.
|
||||
|
||||
## VS Code 확장이 연결되지 않음
|
||||
|
||||
- OpenChamber 서버가 실행 중인지 확인하세요
|
||||
- 확장이 최신인지 확인하세요
|
||||
- VS Code 창을 새로 고치고 연결을 다시 시도하세요
|
||||
|
||||
## 관련 문서
|
||||
|
||||
- [빠른 시작](/ko/quickstart/)
|
||||
- [터널](/ko/tunnels/)
|
||||
- [리버스 프록시](/ko/reverse-proxy/)
|
||||
|
||||
@@ -5,7 +5,7 @@ description: 원격 및 모바일 접근을 위해 OpenChamber를 안전하게
|
||||
|
||||
# 터널
|
||||
|
||||
실행 중인 OpenChamber 인스턴스를 공개하려면 `openchamber tunnel`을 사용하세요.
|
||||
터널은 OpenChamber로 연결되는 공개 링크로, 휴대폰이나 다른 네트워크에서 접근할 수 있게 해줍니다. 실행 중인 인스턴스에 터널을 만들려면 `openchamber tunnel`을 사용하세요.
|
||||
|
||||
## 빠른 시작 (Cloudflare 빠른 모드)
|
||||
|
||||
@@ -27,6 +27,8 @@ openchamber tunnel start --provider cloudflare --mode quick
|
||||
openchamber tunnel status
|
||||
```
|
||||
|
||||
터널이 올라오면 `status`에 공개 URL이 표시됩니다. 그 URL을 열거나 QR 코드를 스캔하면 어디서든 OpenChamber에 접근할 수 있습니다.
|
||||
|
||||
기본적으로 OpenChamber는 대화형 TTY 세션에서 QR 코드를 출력합니다. `--qr`로 QR 출력을 강제하거나 `--no-qr`로 비활성화하세요.
|
||||
|
||||
## 관리형 모드
|
||||
@@ -75,3 +77,7 @@ openchamber tunnel stop --port 3000
|
||||
- OpenChamber 인스턴스(포트)당 활성 터널은 하나입니다
|
||||
- 같은 인스턴스에서 새 모드/공급자를 시작하면 이전 터널이 대체됩니다
|
||||
- 새 연결 링크를 생성하면 사용되지 않은 이전 링크가 무효화됩니다
|
||||
|
||||
## 관련 문서
|
||||
|
||||
- [문제 해결](/ko/troubleshooting/) — 터널 링크가 작동하지 않을 때
|
||||
|
||||
Reference in New Issue
Block a user