Skip to content

Commit d31fad4

Browse files
committed
docs: remove stale config drift references
1 parent f3c4cb3 commit d31fad4

3 files changed

Lines changed: 13 additions & 82 deletions

File tree

docs/PRD.md

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1374,62 +1374,33 @@ The current implementation is not `one click creates immediately`. It uses a **t
13741374
| `Enter` | Select branch / initiate create / confirm create |
13751375
| `Escape` | Close |
13761376

1377-
## 5.4 Config Drift Banner
1378-
1379-
Config Drift Banner warns about config items in `~/.codex/config.toml` that interfere with current app behavior.
1380-
1381-
### 5.4.1 Data Source
1382-
1383-
The data comes from `externalConfigAudit` in the settings payload.
1384-
1385-
### 5.4.2 Display Positions
1386-
1387-
| Scenario | Position |
1388-
| --- | --- |
1389-
| Desktop shell, excluding auth and settings pages | Global top banner |
1390-
| Mobile workspace page | Compact in-page banner |
1391-
| Settings page | Embedded banner at the top of the content area |
1392-
1393-
### 5.4.3 Interaction Capabilities
1394-
1395-
| Feature | Behavior |
1396-
| --- | --- |
1397-
| Expand details | View each finding, line number, and snippet |
1398-
| Check cleanup items | All findings are selected by default |
1399-
| Cleanup | Execute config cleanup |
1400-
| Cleanup success | If a backup path is produced, show it in banner notice |
1401-
| Dismiss | Close the current banner in frontend state only; not a permanent ignore |
1402-
| Load failure | Show failure banner and allow `Refresh` retry |
1403-
1404-
The compact banner on the mobile workspace page does not expand details inline; it routes the user to `/settings`.
1405-
1406-
## 5.5 Connection Status Banner
1377+
## 5.4 Connection Status Banner
14071378

14081379
The global connection banner handles these states in a unified way:
14091380

14101381
- `reconnecting`: show `Reconnecting...`
14111382
- `rejected`: show `Another tab is active`
14121383
- Any other disconnected state: show `Connection lost`
14131384

1414-
## 5.6 Toasts and Notifications
1385+
## 5.5 Toasts and Notifications
14151386

1416-
### 5.6.1 Toast Container
1387+
### 5.5.1 Toast Container
14171388

14181389
The Toast container supports:
14191390

14201391
- Keeping at most the latest `5` toasts at once
14211392
- Four types: `success / error / warning / info`
14221393
- Auto-dismiss, default `5s`; `duration = 0` switches to manual close
14231394

1424-
### 5.6.2 Toast Click Behavior
1395+
### 5.5.2 Toast Click Behavior
14251396

14261397
| Attached toast data | Click result |
14271398
| --- | --- |
14281399
| `workspaceId + sessionId` | Jump to that workspace and focus / scroll into view / pulse-highlight the session |
14291400
| `workspaceId` only | Switch to that workspace and navigate to `/workspace` if needed |
14301401
| No navigation data | Only close the toast |
14311402

1432-
### 5.6.3 Session Completion Notifications
1403+
### 5.5.3 Session Completion Notifications
14331404

14341405
Notifications currently fire only when **an agent finishes one round of work**, with explicit rules:
14351406

@@ -1453,7 +1424,7 @@ If sound is enabled:
14531424
- Prefer playing `/task-complete.wav`
14541425
- Fall back to a Web Audio synthesized sound if playback fails
14551426

1456-
## 5.7 Supervisor Editing Container
1427+
## 5.6 Supervisor Editing Container
14571428

14581429
Supervisor editing interactions are carried by two containers:
14591430

docs/PRD.zh-CN.md

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1392,62 +1392,33 @@ Shortcuts 页面当前提供的是**快捷键配置 UI**,分四类:
13921392
| `Enter` | 选中分支 / 发起创建 / 确认创建 |
13931393
| `Escape` | 关闭 |
13941394

1395-
## 5.4 Config Drift Banner
1396-
1397-
Config Drift Banner 用于提示 `~/.codex/config.toml` 中会干扰当前应用行为的配置项。
1398-
1399-
### 5.4.1 数据来源
1400-
1401-
由设置数据中的 `externalConfigAudit` 提供。
1402-
1403-
### 5.4.2 展示位置
1404-
1405-
| 场景 | 位置 |
1406-
| --- | --- |
1407-
| 桌面壳层(非登录、非设置页) | 顶部全局 banner |
1408-
| 移动工作区页 | 页面内紧凑 banner |
1409-
| 设置页 | 内容区顶部 embedded banner |
1410-
1411-
### 5.4.3 交互能力
1412-
1413-
| 功能点 | 行为 |
1414-
| --- | --- |
1415-
| 展开详情 | 查看每个 finding、行号、片段 |
1416-
| 勾选清理项 | 默认全选全部 findings |
1417-
| Cleanup | 执行配置清理 |
1418-
| Cleanup 成功 | 若产生备份路径,通过 banner notice 展示 |
1419-
| Dismiss | 关闭当前 banner(仅当前前端状态,不是永久忽略) |
1420-
| 加载失败 | 显示失败 banner,并可点击 Refresh 重试 |
1421-
1422-
移动工作区页的紧凑 banner 不在页内展开详情,而是把用户引导到 `/settings`
1423-
1424-
## 5.5 连接状态横幅
1395+
## 5.4 连接状态横幅
14251396

14261397
全局连接横幅统一处理以下状态:
14271398

14281399
- `reconnecting`:显示“正在重新连接...”
14291400
- `rejected`:显示“另一个标签页已激活”
14301401
- 其他非连接态:显示“连接已断开”
14311402

1432-
## 5.6 Toast 与通知
1403+
## 5.5 Toast 与通知
14331404

1434-
### 5.6.1 Toast 容器
1405+
### 5.5.1 Toast 容器
14351406

14361407
Toast 容器支持:
14371408

14381409
- 最多同时保留最近 `5`
14391410
- `success / error / warning / info` 四种类型
14401411
- 自动消失(默认 `5s``duration = 0` 可改为手动)
14411412

1442-
### 5.6.2 Toast 点击行为
1413+
### 5.5.2 Toast 点击行为
14431414

14441415
| Toast 附带数据 | 点击结果 |
14451416
| --- | --- |
14461417
| `workspaceId + sessionId` | 跳到对应 workspace,并让 session 获得聚焦 / 滚动到视野 / 高亮脉冲 |
14471418
|`workspaceId` | 切换到对应 workspace,并在必要时导航到 `/workspace` |
14481419
| 无跳转数据 | 仅关闭 Toast |
14491420

1450-
### 5.6.3 Session 完成通知
1421+
### 5.5.3 Session 完成通知
14511422

14521423
当前只针对“Agent 一轮工作完成”发通知,触发规则非常明确:
14531424

@@ -1471,7 +1442,7 @@ Toast 容器支持:
14711442
- 优先播放 `/task-complete.wav`
14721443
- 播放失败时回退到 Web Audio 合成提示音
14731444

1474-
## 5.7 Supervisor 编辑容器
1445+
## 5.6 Supervisor 编辑容器
14751446

14761447
Supervisor 的编辑类交互由两种容器承载:
14771448

packages/server/src/commands/settings.test.ts

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@ describe("settings commands", () => {
1515
workspaceMgr: {} as never,
1616
sessionMgr: {} as never,
1717
terminalMgr: {} as never,
18-
codexConfigAudit: {
19-
audit: () => ({ codex: { configPath: "/tmp/config.toml", exists: false, findings: [] } }),
20-
cleanup: () => ({ removed: [], backupPath: null, noop: true }),
21-
} as never,
2218
eventBus: {} as never,
2319
broadcaster: {} as never,
2420
db,
@@ -242,7 +238,7 @@ describe("settings commands", () => {
242238
expect(result.data?.["providers.openai.additionalArgs"]).toBeUndefined();
243239
});
244240

245-
it("settings.get reads settings from user_settings and includes config audit metadata", async () => {
241+
it("settings.get reads settings from user_settings", async () => {
246242
db.prepare("INSERT INTO user_settings (key, value) VALUES (?, ?)").run(
247243
"defaultProviderId",
248244
'"codex"'
@@ -271,13 +267,6 @@ describe("settings commands", () => {
271267
defaultProviderId: "codex",
272268
"notifications.enabled": true,
273269
"supervisor.evaluationTimeoutSec": 900,
274-
externalConfigAudit: {
275-
codex: {
276-
configPath: "/tmp/config.toml",
277-
exists: false,
278-
findings: [],
279-
},
280-
},
281270
});
282271
});
283272

0 commit comments

Comments
 (0)