Skip to content

docs: reorganize navigation and clarify runtime guides#2568

Merged
seratch merged 1 commit intomainfrom
docs/reorganize-navigation-and-runtime-guides
Mar 1, 2026
Merged

docs: reorganize navigation and clarify runtime guides#2568
seratch merged 1 commit intomainfrom
docs/reorganize-navigation-and-runtime-guides

Conversation

@seratch
Copy link
Member

@seratch seratch commented Mar 1, 2026

This pull request updates the documentation IA and core guides so it is easier to find the right entry point for first runs, orchestration, streaming, and conversation state.

  • Reorganize the docs navigation across locales so foundational guides appear earlier, related topics are grouped more clearly, and localized API reference sections are exposed consistently.
  • Refocus the quickstart on the first successful agent run, then layer in tools and handoffs with clearer examples and links to matching repo examples.
  • Clarify how to choose between result.to_input_list(), sessions, conversation_id, and previous_response_id, including how streaming completion, approvals, resume flows, and compaction interact with those choices.
  • Tighten terminology around agent orchestration and local/runtime execution tools, and update translation mappings plus localized headings so the English rename stays aligned in Japanese, Korean, and Chinese docs.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 1, 2026
@seratch seratch merged commit da3d45c into main Mar 1, 2026
9 checks passed
@seratch seratch deleted the docs/reorganize-navigation-and-runtime-guides branch March 1, 2026 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant