Skip to content

docs(quickstart): clarify all-in-one includes model providers - #2425

Open
Blue-Berrys wants to merge 3 commits into
agentscope-ai:mainfrom
Blue-Berrys:docs/840-update-installation-all-in-one
Open

docs(quickstart): clarify all-in-one includes model providers#2425
Blue-Berrys wants to merge 3 commits into
agentscope-ai:mainfrom
Blue-Berrys:docs/840-update-installation-all-in-one

Conversation

@Blue-Berrys

Copy link
Copy Markdown

AgentScope-Java Version

2.0.1-SNAPSHOT (docs samples updated to 2.0.0)

Description

Fixes #840.

The V1 installation docs still told all-in-one users to manually add OpenAI / Gemini / Anthropic SDKs, and used outdated 1.0.12 version samples. The agentscope all-in-one artifact already shades the common model extensions (agentscope-extensions-model-openai/gemini/anthropic/dashscope/ollama) and their required SDKs.

Changes:

  • Document that all-in-one includes OpenAI / Gemini / Anthropic / DashScope / Ollama (no extra model SDKs needed)
  • Remove the misleading OpenAI/Gemini/Anthropic rows and the openai-java example from the all-in-one "additional dependencies" section
  • Bump sample dependency versions from 1.0.12 to 2.0.0
  • Update both docs/v1/zh and docs/v1/en

How to verify:

  1. Before: rg 'openai-java|1\.0\.12' docs/v1/*/docs/quickstart/installation.md shows users are told to add openai-java and versions are 1.0.12
  2. After: those docs list model providers under included dependencies and use 2.0.0 samples; OpenAI/Gemini/Anthropic are no longer listed as required extra SDKs for all-in-one
  3. Cross-check agentscope-distribution/agentscope-all/pom.xml still depends on the listed model extensions

Checklist

  • Code has been formatted with mvn spotless:apply — N/A (docs only)
  • All tests are passing (mvn test) — N/A (docs only)
  • Javadoc comments are complete and follow project conventions — N/A
  • Related documentation has been updated (e.g. links, examples, etc.)
  • Code is ready for review

Update installation docs so all-in-one users are not told to add
OpenAI/Gemini/Anthropic SDKs separately, and bump sample versions to 2.0.0.

Fixes agentscope-ai#840
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@Blue-Berrys
Blue-Berrys force-pushed the docs/840-update-installation-all-in-one branch from d21a64a to 160871d Compare July 27, 2026 16:54
@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@oss-maintainer oss-maintainer left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review — Approved ✅

Overall: Documentation clarification for the quickstart guide, making it clear that the "all-in-one" distribution includes model providers.

Changes:

  • Updated quickstart documentation to clarify that "all-in-one" includes model providers
  • Removed 54 lines of outdated content, added 36 lines of clarified content

Code Quality:

  • ✅ Clear documentation improvement
  • ✅ No code logic changes

CI Status: ✅ All checks passed

Verdict: Helpful documentation clarification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Suggest updating the '安装' section of the project documentation

2 participants