Skip to content

[Doc][Umbrella] Improve Calling LLMs documentation #1232

Closed
5 of 5 issues completed
Closed

Description

@wenjin272

Parent: #1225

Goal

Improve the Calling LLMs documentation for 0.4 using the page hierarchy delivered by #1244. Organize implementation work by page, keep framework concepts separate from provider capabilities, and give each topic an authoritative explanation with clear links to related pages.

Work items

Prompts and MCP are included in the final cross-page review. Create additional focused issues only if that review finds substantive gaps; no separate rewrite is required just to mirror every navigation entry.

Coordination and delivery

Final cross-page acceptance

  • Chat Models, Prompts, Chat with Models, Model Routing, Tool Use, MCP, and Skills form a coherent progression with clear cross-links and no unnecessary duplicated explanations.
  • Framework message contracts and provider/model capability limits agree, including multimodal support, source types, and tool calling.
  • YAML, ReAct, configuration reference, and Calling LLMs use consistent terminology, defaults, supported APIs, and behavioral constraints.
  • Representative examples and Java/Python/YAML support statements match the delivered 0.4 APIs; documentation builds and internal links pass verification, with execution coverage and limitations recorded.

Close this umbrella after its children and the integrated Calling LLMs review are complete. The broader documentation review remains under #1225.

Review coverage

The child issues describe their actionable scope independently of the review inventory.

Activity

  1. added
    tech debt[Issue Type] User-unaware issues, such as code refactor and infrastructure maintenance.
    priority/majorDefault priority of the PR or issue.
    on Oct 12, 2026
  2. self-assigned this
    on Oct 14, 2026
  3. changed the title [-][Doc] Reorganize Chat Models, Chat Messages, and provider documentation[/-] [+][Doc] Improve chat model, message, provider, and tool-use documentation[/+] on Oct 14, 2026
  4. changed the title [-][Doc] Improve chat model, message, provider, and tool-use documentation[/-] [+][Doc][Umbrella] Improve Calling LLMs documentation[/+] on Oct 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

fixVersion/0.4.0priority/majorDefault priority of the PR or issue.tech debt[Issue Type] User-unaware issues, such as code refactor and infrastructure maintenance.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions