|
| 1 | +# Web i18n Rollout Tracker |
| 2 | + |
| 3 | +_Last updated: 2026-03-31_ |
| 4 | + |
| 5 | +This document tracks the phased rollout of multilingual support for `apps/web`. |
| 6 | + |
| 7 | +Supported locales: |
| 8 | + |
| 9 | +- `en` |
| 10 | +- `es` |
| 11 | +- `fr` |
| 12 | +- `zh-CN` |
| 13 | + |
| 14 | +Status values: |
| 15 | + |
| 16 | +- `TODO`: Not started |
| 17 | +- `IN_PROGRESS`: Started but not yet shippable |
| 18 | +- `DONE`: Implemented and verified |
| 19 | +- `BLOCKED`: Waiting on a dependency or decision |
| 20 | + |
| 21 | +## Scope |
| 22 | + |
| 23 | +In scope for this rollout: |
| 24 | + |
| 25 | +- frontend-only localization in `apps/web` |
| 26 | +- product-owned UI strings only |
| 27 | +- locale persistence via app settings |
| 28 | +- locale-aware timestamps |
| 29 | +- root screens, settings, onboarding, and mobile pairing in the first shippable stop |
| 30 | + |
| 31 | +Out of scope for this rollout: |
| 32 | + |
| 33 | +- `apps/server` |
| 34 | +- `apps/marketing` |
| 35 | +- user/model/code content translation |
| 36 | +- arbitrary provider/server freeform error translation |
| 37 | + |
| 38 | +## Current Snapshot |
| 39 | + |
| 40 | +Overall status: `IN_PROGRESS` |
| 41 | + |
| 42 | +Completed so far: |
| 43 | + |
| 44 | +- Added `react-intl` to `apps/web` |
| 45 | +- Added locale schema support to `apps/web/src/appSettings.ts` |
| 46 | +- Added the shared i18n scaffolding under `apps/web/src/i18n/` |
| 47 | +- Added initial message catalogs for `en`, `es`, `fr`, and `zh-CN` |
| 48 | +- Wired the root route through a shared `I18nProvider` |
| 49 | +- Made timestamps honor the resolved app locale |
| 50 | +- Updated the timestamp callsites in chat and diff surfaces |
| 51 | +- Added Phase 1 guardrail tests for locale resolution, timestamp formatting, and catalog parity |
| 52 | +- Resolved the repo-wide server typecheck blocker by forcing a single `effect` version across `@effect/*` |
| 53 | +- `apps/web` tests pass |
| 54 | +- `bun fmt` passed |
| 55 | +- `bun lint` passed |
| 56 | +- `bun typecheck` passed |
| 57 | + |
| 58 | +Not yet completed: |
| 59 | + |
| 60 | +- Settings page migration |
| 61 | +- Onboarding migration |
| 62 | +- Mobile pairing migration |
| 63 | + |
| 64 | +## Phase 1 — Infrastructure |
| 65 | + |
| 66 | +Objective: |
| 67 | +Establish the shared localization foundation without coupling it to the server or user content. |
| 68 | + |
| 69 | +Checklist: |
| 70 | + |
| 71 | +- [x] Add `react-intl` to `apps/web` |
| 72 | + - Status: `DONE` |
| 73 | +- [x] Add persisted locale preference to `apps/web/src/appSettings.ts` |
| 74 | + - Status: `DONE` |
| 75 | +- [x] Add shared i18n module in `apps/web/src/i18n/` |
| 76 | + - Status: `DONE` |
| 77 | +- [x] Add message catalogs for `en`, `es`, `fr`, and `zh-CN` |
| 78 | + - Status: `DONE` |
| 79 | +- [ ] Wire `I18nProvider` into [apps/web/src/routes/__root.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/routes/__root.tsx) |
| 80 | + - Status: `DONE` |
| 81 | +- [ ] Expose stable translation helpers for component usage |
| 82 | + - Status: `DONE` |
| 83 | +- [ ] Add locale-aware timestamp formatting in [apps/web/src/timestampFormat.ts](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/timestampFormat.ts) |
| 84 | + - Status: `DONE` |
| 85 | +- [ ] Update timestamp callsites in [apps/web/src/components/chat/MessagesTimeline.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/chat/MessagesTimeline.tsx) |
| 86 | + - Status: `DONE` |
| 87 | +- [ ] Update timestamp callsites in [apps/web/src/components/DiffPanel.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/DiffPanel.tsx) |
| 88 | + - Status: `DONE` |
| 89 | + |
| 90 | +Exit criteria: |
| 91 | + |
| 92 | +- Locale can be resolved at runtime from `system | en | es | fr | zh-CN` |
| 93 | +- The app can render under a single root i18n provider |
| 94 | +- Timestamp formatting can follow the selected app locale |
| 95 | + |
| 96 | +## Phase 2 — First Shippable Surfaces |
| 97 | + |
| 98 | +Objective: |
| 99 | +Ship a coherent multilingual slice that is complete on the highest-value product-owned surfaces. |
| 100 | + |
| 101 | +Checklist: |
| 102 | + |
| 103 | +- [ ] Migrate root route loading/error copy in [apps/web/src/routes/__root.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/routes/__root.tsx) |
| 104 | + - Status: `TODO` |
| 105 | +- [ ] Migrate root keybinding toasts in [apps/web/src/routes/__root.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/routes/__root.tsx) |
| 106 | + - Status: `TODO` |
| 107 | +- [ ] Add language selector to [apps/web/src/routes/_chat.settings.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/routes/_chat.settings.tsx) |
| 108 | + - Status: `TODO` |
| 109 | +- [ ] Migrate product-owned settings copy in [apps/web/src/routes/_chat.settings.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/routes/_chat.settings.tsx) |
| 110 | + - Status: `TODO` |
| 111 | +- [ ] Migrate supporting settings components in [apps/web/src/components/EnvironmentVariablesEditor.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/EnvironmentVariablesEditor.tsx) |
| 112 | + - Status: `TODO` |
| 113 | +- [ ] Migrate supporting settings components in [apps/web/src/components/CustomThemeDialog.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/CustomThemeDialog.tsx) |
| 114 | + - Status: `TODO` |
| 115 | +- [ ] Migrate onboarding content in [apps/web/src/components/onboarding/onboardingSteps.ts](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/onboarding/onboardingSteps.ts) |
| 116 | + - Status: `TODO` |
| 117 | +- [ ] Migrate onboarding controls in [apps/web/src/components/onboarding/OnboardingDialog.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/onboarding/OnboardingDialog.tsx) |
| 118 | + - Status: `TODO` |
| 119 | +- [ ] Migrate mobile pairing UI in [apps/web/src/components/mobile/MobilePairingScreen.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/mobile/MobilePairingScreen.tsx) |
| 120 | + - Status: `TODO` |
| 121 | + |
| 122 | +Exit criteria: |
| 123 | + |
| 124 | +- Users can select a language in Settings without reloading |
| 125 | +- Root screens, Settings, Onboarding, and Mobile Pairing render localized product UI |
| 126 | +- English remains the safe fallback when a locale cannot be resolved or loaded |
| 127 | + |
| 128 | +## Phase 3 — High-Traffic Product Surfaces |
| 129 | + |
| 130 | +Objective: |
| 131 | +Extend localization to the most visible remaining chrome and toast-heavy flows. |
| 132 | + |
| 133 | +Checklist: |
| 134 | + |
| 135 | +- [ ] Migrate sidebar toasts and chrome in [apps/web/src/components/Sidebar.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/Sidebar.tsx) |
| 136 | + - Status: `TODO` |
| 137 | +- [ ] Migrate chat home empty state in [apps/web/src/components/ChatHomeEmptyState.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/ChatHomeEmptyState.tsx) |
| 138 | + - Status: `TODO` |
| 139 | +- [ ] Migrate workspace file tree messages in [apps/web/src/components/WorkspaceFileTree.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/WorkspaceFileTree.tsx) |
| 140 | + - Status: `TODO` |
| 141 | +- [ ] Migrate Git actions UI copy in [apps/web/src/components/GitActionsControl.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/GitActionsControl.tsx) |
| 142 | + - Status: `TODO` |
| 143 | +- [ ] Migrate branch selector copy in [apps/web/src/components/BranchToolbarBranchSelector.tsx](/Users/buns/.okcode/worktrees/okcode/okcode-587a5d98/apps/web/src/components/BranchToolbarBranchSelector.tsx) |
| 144 | + - Status: `TODO` |
| 145 | + |
| 146 | +Exit criteria: |
| 147 | + |
| 148 | +- The highest-traffic app chrome and common toasts are localized |
| 149 | +- Remaining untranslated product UI is narrow and intentional |
| 150 | + |
| 151 | +## Phase 4 — Hardening and Verification |
| 152 | + |
| 153 | +Objective: |
| 154 | +Make the rollout safe to maintain and safe to ship repeatedly. |
| 155 | + |
| 156 | +Checklist: |
| 157 | + |
| 158 | +- [ ] Add locale resolution tests |
| 159 | + - Status: `DONE` |
| 160 | +- [ ] Add app settings default tests for locale |
| 161 | + - Status: `DONE` |
| 162 | +- [ ] Add message catalog parity tests |
| 163 | + - Status: `DONE` |
| 164 | +- [ ] Add timestamp formatting tests |
| 165 | + - Status: `DONE` |
| 166 | +- [ ] Run `bun fmt` |
| 167 | + - Status: `DONE` |
| 168 | +- [ ] Run `bun lint` |
| 169 | + - Status: `DONE` |
| 170 | +- [ ] Run `bun typecheck` |
| 171 | + - Status: `DONE` |
| 172 | + |
| 173 | +Exit criteria: |
| 174 | + |
| 175 | +- Catalog drift is caught by tests |
| 176 | +- Locale behavior is covered by automated checks |
| 177 | +- Required repository quality gates pass |
| 178 | + |
| 179 | +## Shippable Stop |
| 180 | + |
| 181 | +The first shippable stop is: |
| 182 | + |
| 183 | +- Phase 1 complete |
| 184 | +- Phase 2 complete |
| 185 | +- Phase 4 verification complete |
| 186 | + |
| 187 | +Phase 3 can follow later without blocking the first release if the app’s core localized surfaces are already coherent. |
| 188 | + |
| 189 | +## Next Up |
| 190 | + |
| 191 | +Immediate next implementation steps: |
| 192 | + |
| 193 | +1. Migrate root route strings and root toasts. |
| 194 | +2. Migrate Settings and its supporting components. |
| 195 | +3. Migrate Onboarding and Mobile Pairing. |
| 196 | +4. Continue with Phase 2 completion toward the first shippable localized stop. |
0 commit comments