You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "Frun1na (via GitHub)" <gi...@apache.org> on 2026/09/21 13:37:50 UTC

[PR] docs: correct two claims in the AI architecture notes [rocketmq-dashboard]

Frun1na opened a new pull request, #4767:
URL: https://github.com/apache/rocketmq-dashboard/pull/4767

   ### Which Issue(s) This PR Fixes
   
   ### Brief Description
   
   Two claims in `docs/ai-agent-architecture.md` contradict the implementation:
   
   1. **Tool-output truncation scope.** §"一个解析器,两种输出" lists the 32 KiB cut under "两侧内容
      **故意不同**" as "工具输出在落库侧截到 32 KiB" — implying the live SSE stream carries the full
      output and only the persisted copy is cut. `AgentEventProjector` applies the ceiling to both
      sides; its own javadoc says "Ceiling for a tool output **on both sides**", and the same
      `SanitisedOutput` feeds `LiveEvent.ToolDone` and `TimelineEvent.ToolResult`. The statement now
      sits outside the "deliberately different" list and says both sides are cut.
   2. **Checkstyle rule scope.** The note says `style/rmq_checkstyle.xml` rejects non-ASCII characters
      in Java sources. The `RegexpSingleline` rule only matches CJK code points plus fullwidth
      punctuation — its message is literally "Not allow chinese character !" — so Latin-extended text
      (é, ü, …) would pass. The note now says "中文字符(CJK 区段与全角标点)".
   
   ### How Did You Test This Change?
   
   Documentation only, so the Maven and Vitest suites were not re-run. Both claims were read off the
   implementation:
   
   ```
   $ grep -n -B1 "MAX_TOOL_OUTPUT_BYTES" .../ops/ai/conversation/event/AgentEventProjector.java
       /** Ceiling for a tool output on both sides. Beyond this the output is cut and marked truncated. */
       public static final int MAX_TOOL_OUTPUT_BYTES = 32 * 1024;
   
   $ grep -n -A2 "Not allow" server/style/rmq_checkstyle.xml
       <property name="format"
                 value=".*[\u3400-\u4DB5\u4E00-\u9FA5...]+.*"/>
       <property name="message" value="Not allow chinese character !"/>
   ```
   
   ### Checklist
   
   - [x] One coherent change; unrelated modifications are not bundled in
   - [x] Commit subject follows Conventional Commits (`docs:`)
   - [ ] Tests added or updated for non-trivial changes, test methods named `...Test`
   - [ ] New UI text has both Chinese and English entries under `web/src/i18n/`
   - [ ] Architecture constraints stay green (`mvn test` runs the ArchUnit checks)
   - [ ] New source files carry the ASF license header
   - [x] Documentation touched where behaviour changed (README / `docs/` / in-app help)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: correct two claims in the AI architecture notes [rocketmq-dashboard]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #4767:
URL: https://github.com/apache/rocketmq-dashboard/pull/4767#issuecomment-5881203745

   This pull request has been automatically closed because there has been no activity for 7 days. If you would like to continue working on this, please reopen the PR with updated changes.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: correct two claims in the AI architecture notes [rocketmq-dashboard]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #4767: docs: correct two claims in the AI architecture notes
URL: https://github.com/apache/rocketmq-dashboard/pull/4767


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org