Document every primary control-center section in README

This commit is contained in:
OpenClaw Local committed 2026-03-11 13:42:37 +01:00
1 parent ea47dec402
commit a06a40576d
3 files changed
+102

No files matched your search

+37
View File
@@ -45,6 +45,43 @@ Then open:
- `http://127.0.0.1:4310/?section=overview&lang=en`
- `http://127.0.0.1:4310/?section=overview&lang=zh`
## Section-by-section tour
### Overview
- The main operating screen for non-technical users.
- Shows the current control posture, key action items, runtime issues, stalled runs, budget risk, who is active, and what needs attention first.
- Best when you want one fast answer to: “Is OpenClaw okay right now?”
### Usage
- Shows today, 7-day, and 30-day usage and spend trends.
- Includes subscription windows, quota consumption, usage mix, and connector status.
- Best when you want to know whether spend or quota is becoming risky.
### Staff
- Shows who is truly active now versus who only has queued work.
- Separates live work from “next up” so backlog is not confused with active execution.
- Best when you want to know who is busy, idle, blocked, or waiting.
### Memory
- A source-backed workbench for daily and long-term memory files.
- Scoped to active OpenClaw agents from `openclaw.json`, so deleted agents do not keep showing up.
- Best when you want to inspect or edit memory that the current OpenClaw team is actually using.
### Documents
- A source-backed workbench for shared and agent-specific core markdown docs.
- Reads the real source files and writes back to the same files.
- Best when you want to maintain the actual working documents behind the system.
### Tasks
- Combines task board, schedule, approvals, execution chains, and runtime evidence.
- Helps distinguish mapped work from real execution evidence, and shows what is blocked or needs review.
- Best when you want to understand what is being carried, what is only planned, and what needs intervention.
### Settings
- Shows safety mode, connector status, and data-link expectations.
- Makes it clear what is connected, what is still partial, and which high-risk actions are intentionally disabled.
- Best when you want to verify environment setup or explain why a signal is missing.
For:
- Existing OpenClaw users who want a local control center for observability, usage, staff activity, tasks, approvals, replay, and documents.
- Teams running OpenClaw on the same machine or a reachable local environment.
+37
View File
@@ -45,6 +45,43 @@ UI_MODE=true npm run dev
- `http://127.0.0.1:4310/?section=overview&lang=zh`
- `http://127.0.0.1:4310/?section=overview&lang=en`
## 分区功能说明
### 总览
- 给非技术用户看的主操作页。
- 集中展示当前总控态势、待处理事项、运行异常、停滞执行、预算风险、谁在忙、哪些地方需要优先关注。
- 最适合快速回答一句话:`OpenClaw 现在整体正常吗?`
### 用量
- 展示今日、7 天、30 天的用量和花费趋势。
- 包含订阅窗口、配额消耗、用量结构和数据连接状态。
- 最适合判断花费或额度是否开始有风险。
### 员工
- 展示谁现在真的在工作,谁只是有排队中的任务。
- 明确区分“正在执行”和“下一项”,避免把 backlog 误认为正在跑。
- 最适合判断谁忙、谁闲、谁卡住、谁在等待。
### 记忆
- 一个直接基于源文件的记忆工作台,用来查看和编辑每日记忆与长期记忆。
- 范围跟随 `openclaw.json` 里的活跃 agent,不会把已删除 agent 继续显示出来。
- 最适合查看或维护当前 OpenClaw 团队真实在用的记忆内容。
### 文档
- 一个直接基于源文件的文档工作台,用来查看和编辑共享文档与 agent 核心文档。
- 打开的是实际源文件,保存后也直接写回同一个源文件。
- 最适合维护系统背后真正生效的工作文档。
### 任务
- 把任务板、排期、审批、执行链和运行证据放在同一个分区里。
- 能帮助区分哪些只是看板映射,哪些已经有真实执行证据,哪些任务卡住了、需要跟进或待审。
- 最适合理解“现在到底在做什么、只是计划了什么、哪些需要你介入”。
### 设置
- 展示安全模式、连接器状态和数据链路预期。
- 会明确告诉你哪些数据已经接上,哪些还只是部分可见,哪些高风险动作是故意关闭的。
- 最适合排查环境配置、解释为什么某些信号缺失。
## 核心约束
- 只修改 `control-center/` 目录内的文件
- 默认 `READONLY_MODE=true`
+28
View File
@@ -1,5 +1,33 @@
# Progress
## Phase 132 (README now explains every primary product section) — Completed
- Scope:
- Make the public README explain what each main control-center section actually does instead of only showing screenshots and setup steps.
- Keep the explanation operator-facing and useful for non-technical readers in both English and Chinese.
- Changed files:
- `README.md`
- `README.zh-CN.md`
- `docs/PROGRESS.md`
- Implementation:
- Added a full section-by-section tour to the English README:
- Overview
- Usage
- Staff
- Memory
- Documents
- Tasks
- Settings
- Added the matching Chinese section guide to `README.zh-CN.md`.
- Wrote each section in plain language around:
- what it shows
- why it matters
- when to use it
- Verification:
- `npm run release:audit` passed.
- `npm run build` passed.
- `npm test` passed.
- `npm run smoke:ui` passed.
## Phase 131 (README hero switched from icon block to wide overview screenshot) — Completed
- Scope:
- Replace the weak-looking small icon block at the top of the public README with a product-led hero that immediately shows the real UI.