docs(model): Improve documentation#1986
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the v2 English/Chinese documentation to reflect the “model providers as extension modules” architecture, and documents the recommended model creation paths (string model id vs explicit builders vs Spring Boot starters), plus the newer ModelRegistry/ModelCreationContext concepts.
Changes:
- Expand model-layer docs to explain core contracts vs provider extensions, SPI discovery, and cache policy behavior.
- Add guidance on choosing a model creation path (string id, explicit builder, Spring Boot starters).
- Update agent docs to clarify that
ModelRegistrystring ids require the corresponding model extension module on the classpath.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/v2/zh/docs/building-blocks/model.md | Expands model documentation (creation paths, extension modules, registry/context, caching, SPI) and updates credential import example. |
| docs/v2/zh/docs/building-blocks/agent.md | Clarifies classpath requirement for ModelRegistry string ids. |
| docs/v2/en/docs/building-blocks/model.md | English counterpart of the model doc expansion and import update. |
| docs/v2/en/docs/building-blocks/agent.md | English counterpart of the classpath requirement clarification. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
zouyx
approved these changes
Jul 3, 2026
zouyx
left a comment
zouyx
left a comment
Contributor
There was a problem hiding this comment.
LGTM
But can you descrise the background of these changes?
zouyx
pushed a commit
to zouyx/agentscope-java
that referenced
this pull request
Jul 6, 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
[The version of AgentScope-Java you are working on, e.g. 1.0.12, check your pom.xml dependency version or run
mvn dependency:tree | grep agentscope-parent:pom(only mac/linux)]Description
[Please describe the background, purpose, changes made, and how to test this PR]
Checklist
Please check the following items before code is ready to be reviewed.
mvn spotless:applymvn test)