fix(docs): align documentation with actual codebase #1107
Merged
chickenlj merged 3 commits intoagentscope-ai:mainfrom Apr 13, 2026
Merged
fix(docs): align documentation with actual codebase #1107chickenlj merged 3 commits intoagentscope-ai:mainfrom
chickenlj merged 3 commits intoagentscope-ai:mainfrom
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the English and Chinese documentation to match the current AgentScope Java (1.0.11) APIs and runtime behaviors, mainly correcting outdated code examples and capability matrices.
Changes:
- Update doc code snippets to current APIs (e.g.,
Msg.builder().textContent(...),ReActAgent.builder().toolkit(...), new tool-choice classes). - Clarify/expand documented behaviors and capabilities (hooks/events, multimodal tool capabilities, model options, workflow defaults).
- Fix/adjust cross-doc links and configuration notes to reflect the current module structure.
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/zh/task/tts.md | Update TTS examples to new Msg builder API and Toolkit-based tool registration |
| docs/zh/task/tool.md | Clarify streaming tools, add list_directory, update Toolkit defaults and suspend-resume example |
| docs/zh/task/studio.md | Clarify Studio runs as a frontend dev server |
| docs/zh/task/rag.md | Remove outdated RAG option (enableOnlyForUserQueries) |
| docs/zh/task/plan.md | Document needUserConfirm behavior and defaults |
| docs/zh/task/online-training.md | Update message creation API in example |
| docs/zh/task/model.md | Update model capability matrix and add DashScope/OpenAI option details |
| docs/zh/task/memory.md | Fix related-doc link to current agent config doc |
| docs/zh/task/mcp.md | Fix tool group variable usage and clarify HTTP-only params/headers behavior |
| docs/zh/task/hook.md | Update hook modifiability and add summary hook events |
| docs/zh/task/agent-skill.md | Update SkillBox construction to include Toolkit |
| docs/zh/task/agent-config.md | Update skill example to new AgentSkill.builder() style |
| docs/zh/task/a2a.md | Update AgentCard skill examples to builder pattern |
| docs/zh/quickstart/key-concepts.md | Align key concepts with current message fields, reasons, and agent interfaces |
| docs/zh/quickstart/installation.md | Update dependency/module listing notes |
| docs/zh/quickstart/agent.md | Align ReActAgent builder parameter list with current options |
| docs/zh/multi-agent/workflow.md | Clarify workflow example defaults and runner behavior |
| docs/zh/multi-agent/handoffs.md | Fix AgentScopeAgent import path |
| docs/zh/intro.md | Align intro claims with current architecture/modules (A2A, tracing, etc.) |
| docs/en/task/tts.md | Update TTS examples to new Msg builder API and Toolkit-based tool registration |
| docs/en/task/tool.md | Clarify streaming tools, add list_directory, update Toolkit defaults and suspend-resume example |
| docs/en/task/studio.md | Clarify Studio runs as a frontend dev server |
| docs/en/task/rag.md | Remove outdated RAG option (enableOnlyForUserQueries) |
| docs/en/task/plan.md | Document needUserConfirm behavior and defaults |
| docs/en/task/online-training.md | Update message creation API in example |
| docs/en/task/model.md | Update model capability matrix and add DashScope/OpenAI option details |
| docs/en/task/memory.md | Fix related-doc link to current agent config doc |
| docs/en/task/mcp.md | Fix tool group variable usage and clarify HTTP-only params/headers behavior |
| docs/en/task/hook.md | Update hook modifiability and add summary hook events |
| docs/en/task/agent-skill.md | Update SkillBox construction to include Toolkit |
| docs/en/task/agent-config.md | Update skill example (needs correction for compile validity) |
| docs/en/task/a2a.md | Update AgentCard skill examples to builder pattern |
| docs/en/quickstart/key-concepts.md | Align key concepts with current message fields, reasons, and agent interfaces |
| docs/en/quickstart/installation.md | Update dependency/module listing notes |
| docs/en/quickstart/agent.md | Align ReActAgent builder parameter list with current options |
| docs/en/multi-agent/workflow.md | Clarify workflow example defaults and runner behavior |
| docs/en/multi-agent/handoffs.md | Fix AgentScopeAgent import path and add descriptions |
| docs/en/intro.md | Align intro claims with current architecture/modules (A2A, tracing, etc.) |
chickenlj
approved these changes
Apr 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AgentScope-Java Version
1.0.11
Description
fix(docs): align documentation with actual codebase
Checklist
Please check the following items before code is ready to be reviewed.
mvn spotless:applymvn test)