This is an automated email from the ASF dual-hosted git repository.
lizhimins pushed a commit to branch rocketmq-studio
in repository https://gitbox.apache.org/repos/asf/rocketmq-dashboard.git
The following commit(s) were added to refs/heads/rocketmq-studio by this push:
new 9d3993792 docs: sync the Chinese README and correct two AI
architecture claims (#5267)
9d3993792 is described below
commit 9d3993792670b91244fd3739f0cf09e06107d47c
Author: Apulupie <[email protected]>
AuthorDate: Fri Oct 9 17:59:30 2026 +0800
docs: sync the Chinese README and correct two AI architecture claims (#5267)
Two documentation corrections.
- `README_zh.md` was missing the Quick Start paragraph the English README
has: the default schema
creates only Studio tables and seeds no instances, topics, consumer
groups or ACL data; demo data is
imported explicitly from `deploy/mysql/` (`upgrade-demo-instance.sql`
then `upgrade-demo-acl.sql`),
those scripts are repeatable demo loaders rather than upgrade migrations,
and they must not be run
against a production database. The feature table's cluster-management row
also gains NameServer
configuration drift detection. Rebased onto today's #5439, so the
corrected port line stays. (#5267)
- `docs/ai-agent-architecture.md` stated two things the implementation does
not do: tool output is
truncated to 32 KiB on both the live and the persisted side (it was
listed as a deliberate
difference between them), and `style/rmq_checkstyle.xml` rejects CJK
characters and full-width
punctuation rather than every non-ASCII character (Latin extensions are
allowed). (#5271)
Folded in #5271 (same author).
---
README_zh.md | 7 ++++++-
docs/ai-agent-architecture.md | 9 +++++----
2 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/README_zh.md b/README_zh.md
index 46560ee41..17d2fd4a9 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -41,6 +41,11 @@ docker compose -f deploy/docker-compose.yml up -d --build
RocketMQ 集群。要管理真实资源，请注册一个指向你自己 RocketMQ 的实例，或启动下方的
「内置 RocketMQ 集群（可选）」。
+默认 schema 只创建 Studio 所需的表，不写入实例、Topic、消费组或 ACL 示例数据。开发用的演示数据需从
+`deploy/mysql/` 显式导入，不属于默认部署的一部分：先导入 `upgrade-demo-instance.sql`，再导入
+`upgrade-demo-acl.sql`。两个脚本都按当前数字主键 schema 编写、可重复执行，只是示例数据装载器而非
+升级迁移脚本，切勿导入生产数据库。
+
**Studio 服务端口：** 前端 6789（Nginx，同时代理 `/api`）、后端 8888（Spring Boot，仅容器内可达；后端在
compose 之外直接运行时才对外暴露）
共享环境可复制 `deploy/.env.example` 为 `deploy/.env`，设置
@@ -86,7 +91,7 @@ docker compose -f deploy/rocketmq/docker-compose.yml up -d
|------|------|
| **监控面板** | 集群/ Broker / Topic / 消费组全局统计，TPS 趋势图 |
| **实例管理** | 多实例接入（Proxy / Direct 模式），实例 CRUD |
-| **集群管理** | 集群详情、Broker / NameServer / Proxy 节点运维、集群配置热更新 |
+| **集群管理** | 集群详情、Broker / NameServer / Proxy 节点运维、集群配置热更新、NameServer 配置漂移检测 |
| **K8s 证书** | Studio 本地 TLS / mTLS / ServiceAccount 证书配置 |
| **Topic 管理** | Topic CRUD、路由查看、消费者列表、多类型支持（Normal / FIFO / Delay /
Transaction / Lite） |
| **消费组管理** | 消费组 CRUD、消费进度、订阅详情、位点重置、配置导入导出 |
diff --git a/docs/ai-agent-architecture.md b/docs/ai-agent-architecture.md
index c38f3711d..25a54861e 100644
--- a/docs/ai-agent-architecture.md
+++ b/docs/ai-agent-architecture.md
@@ -134,9 +134,9 @@ Agent 循环 ⊃ 一条时间线条目。不带多租户 `tenant_id`、`shareSco
**一个解析器，两种输出**：`AgentEventProjector` 对每个 `AgentEvent` 产出「一个可空的 `LiveEvent` +
一个可空的 `TimelineEvent` 列表」。同一条上游消息可能只产 live、只产落库、两者都产或都不产，而且
-两侧内容**故意不同**：delta 只走 live（落库侧由缓冲写在合并边界产出一条完整 `text`）；工具输出在
-落库侧截到 32 KiB 并保留 `outputBytes`/`truncated`。它对 sealed 类型做穷尽 switch 且不写
`default`，
-新增子类型即编译错误。
+两侧内容**故意不同**：delta 只走 live（落库侧由缓冲写在合并边界产出一条完整 `text`）。工具输出则
+在 live 与落库**两侧都**截到 32 KiB 并保留 `outputBytes`/`truncated`，这一点两侧一致。它对 sealed
+类型做穷尽 switch 且不写 `default`，新增子类型即编译错误。
`ThinkingSource = {MODEL, ENHANCE}` 这一个字段修掉了一个真实的错标 bug：改造前 UI 把 **prompt 增强
改写**渲染在标题为「思维链」的折叠块里。两种来源的 thinking **只在 source 相同时才合并**，否则就是
@@ -245,7 +245,8 @@ MCP 那条路没有角色校验是**设计如此**：它靠实例 AK/SK 鉴权
**会话仍然能当纯聊天用**——这是硬要求，降级是可发现的，不是神秘的。
两条提示的可读中文原文放在 `server/src/test/resources/ai/agent-notices.txt`，生产代码里用 `\uXXXX`
-转义写（`style/rmq_checkstyle.xml` 拒绝 Java 源文件里的非 ASCII 字符），`RmqctlWorkspaceTest`
读这个文件
+转义写（`style/rmq_checkstyle.xml` 拒绝 Java 源文件里的中文字符——CJK 区段与全角标点，拉丁扩展
+不在其列），`RmqctlWorkspaceTest` 读这个文件
断言「转义确实解码成这句话」——测试里重复一遍转义等于什么都没断言。该文件用 `.txt` 而不是 `.properties`
是为了避开 checkstyle 的 `resourceIncludes (**/*.properties)`，不要重命名。
