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/es/index.mdx
+3 -3
View File
@@ -5,12 +5,12 @@ description: Guía de configuración y uso de OpenChamber en web, escritorio y V
# Documentación de OpenChamber
OpenChamber es el espacio de trabajo visual en torno a OpenCode.
OpenChamber es el espacio de trabajo visual en torno a OpenCode (el agente de programación con IA que se ejecuta en tu terminal). Te da una pantalla para observar y dirigir ese trabajo, en lugar de vivir en la línea de comandos.
Usa esta documentación para:
- instalar la plataforma adecuada para tu flujo de trabajo
- exponer OpenChamber de forma segura para uso remoto
- instalar la app adecuada para tu forma de trabajar
- abrir OpenChamber para un uso remoto seguro
- personalizar la apariencia y resolver problemas comunes
## Lee esto primero
packages/docs/content/docs/es/install.mdx
+6 -6
View File
@@ -5,15 +5,15 @@ description: Instala OpenChamber para escritorio, web o VS Code.
# Instalación
OpenChamber tiene tres plataformas principales:
Hay tres formas de ejecutar OpenChamber:
- app de escritorio para macOS
- app web alojada por la CLI con PWA instalable
- app web alojada por la CLI, que puedes instalar como una app de teléfono (una PWA)
- extensión para VS Code
## Requisito previo
Instala [OpenCode](https://opencode.ai) primero.
Instala [OpenCode](https://opencode.ai) primero: OpenChamber se ejecuta sobre él.
## Web + PWA
@@ -22,12 +22,12 @@ curl -fsSL https://raw.githubusercontent.com/openchamber/openchamber/main/script
openchamber --ui-password be-creative-here
```
Luego abre la URL que imprime la CLI (normalmente `http://localhost:3000`).
Abre la URL que imprime la CLI (normalmente `http://localhost:3000`). Deberías ver la lista de sesiones de OpenChamber. Para tenerlo a mano, usa la opción "Instalar" de tu navegador en la barra de direcciones para añadirlo como una app.
## Escritorio
Descarga la última compilación de escritorio desde la página de releases de GitHub o la página de descargas de OpenChamber.
Descarga la última compilación de escritorio desde la página de releases de GitHub o la página de descargas de OpenChamber. Ábrela e inicia sesión con tu flujo de trabajo habitual de OpenCode.
## VS Code
Instálala desde el VS Code Marketplace e inicia sesión con tu flujo de trabajo habitual de OpenCode.
Instálala desde el VS Code Marketplace e inicia sesión con tu flujo de trabajo habitual de OpenCode. La vista de OpenChamber se abre entonces en la barra lateral.
packages/docs/content/docs/es/quickstart.mdx
+14 -10
View File
@@ -1,22 +1,26 @@
---
title: Inicio rápido
description: Inicia OpenChamber rápidamente y elige la plataforma adecuada para la tarea.
description: Inicia OpenChamber rápidamente y elige la app adecuada para la tarea.
---
# Inicio rápido
## La vía más rápida
1. Instala OpenCode.
2. Instala la CLI de OpenChamber.
1. Instala [OpenCode](https://opencode.ai).
2. Instala la CLI de OpenChamber (consulta [Instalación](/es/install/) para el comando de una sola línea).
3. Ejecuta `openchamber --ui-password be-creative-here`.
4. Abre la UI web en tu máquina.
5. Si lo necesitas, inicia un túnel y escanea el código QR desde tu teléfono.
4. Abre la URL que imprime la CLI (normalmente `http://localhost:3000`).
5. Para usarlo desde tu teléfono, inicia un [túnel](/es/tunnels/) y escanea el código QR.
Usa una contraseña de UI fuerte, sobre todo si piensas exponer la instancia de forma remota.
Deberías ver la lista de sesiones de OpenChamber en tu navegador. Si carga, ya está todo en marcha.
## ¿Qué plataforma debería usar?
Usa una contraseña de UI fuerte, sobre todo si piensas exponer la instancia a internet.
- usa **escritorio** para el día a día en flujos de trabajo centrados en macOS
- usa **web** para acceso remoto y revisión desde el móvil
- usa **VS Code** para sesiones nativas del editor, junto al código
Si la página no carga, consulta [Resolución de problemas](/es/troubleshooting/).
## ¿Qué app debería usar?
- usa **escritorio** para el día a día en macOS
- usa **web** para acceso remoto y revisión desde el teléfono
- usa **VS Code** para sesiones junto a tu código
packages/docs/content/docs/es/themes.mdx
+1 -1
View File
@@ -17,7 +17,7 @@ mkdir -p ~/.config/openchamber/themes
2. Añade tu archivo JSON a ese directorio (por ejemplo, `my-theme.json`).
3. Abre OpenChamber y ve a **Settings -> Theme -> Reload themes**.
4. Elige tu tema en el desplegable.
4. Elige tu tema en el desplegable. Se aplica de inmediato.
## Ubicación de los temas
packages/docs/content/docs/es/troubleshooting.mdx
+10
View File
@@ -5,6 +5,8 @@ description: Problemas comunes de configuración y ejecución con soluciones rá
# Resolución de problemas
¿Te topaste con un problema? Busca el síntoma abajo y prueba la solución.
## El comando OpenChamber se cierra o no arranca
- confirma que Node.js es `>=20`
@@ -23,8 +25,16 @@ description: Problemas comunes de configuración y ejecución con soluciones rá
- reinicia el túnel desde la misma instancia/puerto
- regenera el enlace de conexión si el token anterior ya se usó
Consulta [Túneles](/es/tunnels/) para la configuración completa, y [Proxy inverso](/es/reverse-proxy/) si usas uno.
## La extensión de VS Code no se conecta
- confirma que el servidor de OpenChamber está en marcha
- verifica que la extensión está actualizada
- recarga la ventana de VS Code y reintenta la conexión
## Relacionado
- [Inicio rápido](/es/quickstart/)
- [Túneles](/es/tunnels/)
- [Proxy inverso](/es/reverse-proxy/)
packages/docs/content/docs/es/tunnels.mdx
+7 -1
View File
@@ -5,7 +5,7 @@ description: Expón OpenChamber de forma segura para acceso remoto y móvil.
# Túneles
Usa `openchamber tunnel` para exponer una instancia de OpenChamber en marcha.
Un túnel es un enlace público a tu OpenChamber, para que puedas acceder a él desde tu teléfono u otra red. Usa `openchamber tunnel` para crear uno para una instancia en marcha.
## Inicio rápido (modo rápido de Cloudflare)
@@ -27,6 +27,8 @@ openchamber tunnel start --provider cloudflare --mode quick
openchamber tunnel status
```
Cuando el túnel está activo, `status` muestra una URL pública. Ábrela, o escanea el código QR, para acceder a OpenChamber desde cualquier lugar.
Por defecto, OpenChamber imprime un código QR en sesiones TTY interactivas. Usa `--qr` para forzar la salida del QR, o `--no-qr` para desactivarla.
## Modos gestionados
@@ -75,3 +77,7 @@ openchamber tunnel stop --port 3000
- un único túnel activo por instancia de OpenChamber (puerto)
- iniciar un nuevo modo/proveedor en la misma instancia reemplaza el túnel anterior
- generar un nuevo enlace de conexión revoca el anterior sin usar
## Relacionado
- [Resolución de problemas](/es/troubleshooting/) — si el enlace del túnel no funciona