Skip to content

Commit 001ed98

Browse files
docs(viewer): clarify new locales ship via PR, not drop-in
Addresses CodeRabbit review on rohitg00#541. Both README.md (Viewer language section + the env table at the bottom) and .env.example referenced 'Drop src/viewer/locales/<lang>.json', which is misleading for npm/global installs that ship dist/ without a src/ tree. Rewords to explicitly call out the PR-against-repo path (source checkout required) so users do not assume a runtime drop-in mechanism exists. Signed-off-by: Christian Walter <chris.walter@mail.de>
1 parent 46d59aa commit 001ed98

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
# -----------------------------------------------------------------------------
105105

106106
# AGENTMEMORY_AUTO_COMPRESS=true # Run LLM compression on every observation batch (requires a provider key). Default off — synthetic compression handles most cases.
107-
# VIEWER_LANGUAGE=en # Viewer UI language. Built-in: en, de. Drop src/viewer/locales/<lang>.json to add more. Falls back to en for missing keys.
107+
# VIEWER_LANGUAGE=en # Viewer UI language. Built-in: en, de. Falls back to en for missing keys. New languages ship via PR (src/viewer/locales/<lang>.json) — see CONTRIBUTING.md.
108108
# AGENTMEMORY_INJECT_CONTEXT=true # Inject recalled memories back into agent prompts (#143). Default off — hooks capture observations but do not modify conversation.
109109
# CONSOLIDATION_ENABLED=true # Run the 4-tier consolidation pipeline (memories → semantic → procedural). Default off — opt in once you've measured the LLM cost.
110110
# CONSOLIDATION_DECAY_DAYS=30 # Age (days) after which non-reinforced memories decay during consolidation

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -925,7 +925,7 @@ The viewer UI defaults to English. Switch it via `.env`:
925925
VIEWER_LANGUAGE=de
926926
```
927927

928-
Restart agentmemory to apply. Built-in locales: `en`, `de`. Missing keys fall back to English. To contribute a new language, copy `src/viewer/locales/en.json`, translate the values, and open a PR — no code changes required. See [Contributing a translation](CONTRIBUTING.md#contributing-a-translation).
928+
Restart agentmemory to apply. Built-in locales: `en`, `de`. Missing keys fall back to English. New locales ship via PR against this repo — there is no drop-in location in packaged installs. To contribute, work from a source checkout: copy `src/viewer/locales/en.json` to `<lang>.json`, translate the values, and open a PR — no code changes required. See [Contributing a translation](CONTRIBUTING.md#contributing-a-translation).
929929

930930
---
931931

@@ -1172,7 +1172,7 @@ Create `~/.agentmemory/.env`:
11721172
# SNAPSHOT_ENABLED=false
11731173
11741174
# Viewer language
1175-
# VIEWER_LANGUAGE=en # Viewer UI language. Built-in: en, de. Drop src/viewer/locales/<lang>.json to add more. Falls back to en for missing keys.
1175+
# VIEWER_LANGUAGE=en # Viewer UI language. Built-in: en, de. Falls back to en for missing keys. New languages via PR (src/viewer/locales/<lang>.json), see CONTRIBUTING.md.
11761176
11771177
# Team
11781178
# TEAM_ID=

0 commit comments

Comments
 (0)