From 399b9f8d9d07c8312b8dd324eae705093dc53dcc Mon Sep 17 00:00:00 2001 From: diegosouzapw Date: Wed, 13 May 2026 17:20:57 -0300 Subject: [PATCH] docs(env): document docs translation pipeline env vars MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds OMNIROUTE_TRANSLATION_API_URL, OMNIROUTE_TRANSLATION_API_KEY, OMNIROUTE_TRANSLATION_MODEL, OMNIROUTE_TRANSLATION_TIMEOUT_MS, and OMNIROUTE_TRANSLATION_CONCURRENCY to both .env.example (commented placeholders) and docs/reference/ENVIRONMENT.md (new 'Docs translation pipeline' subsection). Restores the env-doc-sync contract reported by the strict checker added in FASE 2 — these vars are now referenced by scripts/i18n/run-translation.mjs introduced in this branch. Co-Authored-By: Claude Opus 4.7 (1M context) --- .env.example | 12 ++++++++++++ docs/reference/ENVIRONMENT.md | 14 ++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/.env.example b/.env.example index cf179cba46..8ecf74c35e 100644 --- a/.env.example +++ b/.env.example @@ -1087,6 +1087,18 @@ APP_LOG_TO_FILE=true # become healthy. Default: 180000. # ECOSYSTEM_SERVER_WAIT_MS=180000 +# Docs translation pipeline (used by scripts/i18n/run-translation.mjs). +# OpenAI-compatible base URL, e.g. https://cloud.omniroute.online/v1 +# OMNIROUTE_TRANSLATION_API_URL= +# Bearer token for the translation backend (NEVER commit a real key here). +# OMNIROUTE_TRANSLATION_API_KEY= +# Model id, e.g. gpt-4o-mini or cx/gpt-5.4-mini. +# OMNIROUTE_TRANSLATION_MODEL=gpt-4o-mini +# Per-request timeout in milliseconds (default 60000). +# OMNIROUTE_TRANSLATION_TIMEOUT_MS=60000 +# Number of parallel translation requests (default 4). +# OMNIROUTE_TRANSLATION_CONCURRENCY=4 + # Electron smoke harness (used by scripts/smoke-electron-packaged.mjs). # ELECTRON_SMOKE_URL=http://127.0.0.1:20128/login # ELECTRON_SMOKE_TIMEOUT_MS=45000 diff --git a/docs/reference/ENVIRONMENT.md b/docs/reference/ENVIRONMENT.md index 980db87602..81af365f9e 100644 --- a/docs/reference/ENVIRONMENT.md +++ b/docs/reference/ENVIRONMENT.md @@ -809,6 +809,20 @@ value below unset in production deployments. | `ELECTRON_SMOKE_STREAM_LOGS` | `0` | `scripts/smoke-electron-packaged.mjs` | Set `1` to stream Electron logs to stdout during the run. | | `CLI_DEVIN_BIN` | _(PATH lookup)_ | `open-sse/executors/devin-cli.ts` | Override the Devin CLI binary path. | +### Docs translation pipeline + +Used by `scripts/i18n/run-translation.mjs` (the `npm run i18n:run` command). +All five variables are unset by default — set them in `.env` only on machines +that should be able to run the docs translator. + +| Variable | Default | Source File | Description | +| ----------------------------------- | --------- | ---------------------------------- | ------------------------------------------------------------------------- | +| `OMNIROUTE_TRANSLATION_API_URL` | _(unset)_ | `scripts/i18n/run-translation.mjs` | OpenAI-compatible base URL for the translation backend. | +| `OMNIROUTE_TRANSLATION_API_KEY` | _(unset)_ | `scripts/i18n/run-translation.mjs` | Bearer token for the translation backend (never logged). | +| `OMNIROUTE_TRANSLATION_MODEL` | _(unset)_ | `scripts/i18n/run-translation.mjs` | Model id, e.g. `gpt-4o-mini` or `cx/gpt-5.4-mini`. | +| `OMNIROUTE_TRANSLATION_TIMEOUT_MS` | `60000` | `scripts/i18n/run-translation.mjs` | Per-request timeout in milliseconds. | +| `OMNIROUTE_TRANSLATION_CONCURRENCY` | `4` | `scripts/i18n/run-translation.mjs` | Parallel translation requests when running over multiple files / locales. | + --- ## Audit: Removed / Dead Variables