Documentation DX Improvement & Re-organization (Tracking Issue)

[Timonwa]

Description

Track the ongoing documentation audit, DX improvements, and restructuring of ADK-TS docs. This issue provides visibility into progress across documentation content, code snippet validation, re-organization, and the new documentation structure. Related PRs/Issues will be linked here.

Scope:

• Improve developer experience and clarity
• Update outdated or incorrect information
• Test and fix code snippets
• Re-organize documentation structure
• Add audit-suggested sections (Architecture Deep Dive, Guides)

Doc structure (re-classification):

Old Structure	New Structure	Status
Framework	Docs	In progress
—	API Reference	Completed
—	CLI Reference	Completed
MCP Servers	MCP Servers	Not started

Docs progress tracker:

• Get Started

  • Overview
  • Installation
  • Quickstart

• Agents

  • Overview
  • LLM Agents
  • Models
  • Agent Builder
  • Workflow Agents
    • Sequential Agents
    • Parallel Agents
    • Loop Agents
    • LangGraph
  • Custom Agents
  • Multi-Agent Systems

• Tools

  • Overview
  • Function Tools
  • createTool
  • ToolContext
  • Built-in Tools
  • MCP Tools
  • Google Cloud Tools
  • OpenAPI Tools
  • Authentication
  • Third-Party Tools

• Sessions

  • Overview
  • Sessions
  • State
  • Memory
  • Verpex AI

• Runtime & Execution

  • Overview
  • Runtime Config
  • Event Loop
  • Invocation Lifecycle
  • Performance

• Context

  • Overview
  • Context Management
  • ReadonlyContext
  • CallbackContext
  • ToolContext
  • InvocationContext
  • Context Patterns

• Events

  • Overview
  • Event Actions
  • Working with Events
  • Event Streaming
  • Event Patterns

• Artifacts

  • Overview
  • Artifacts
  • Service Implementations
  • Context Integration
  • Best Practices

• Callbacks

  • Overview
  • Callbacks
  • Callback Types
  • Design Patterns & Best Practices
  • Context Patterns

• Evaluation

  • Overview
  • Evaluation Concepts
  • Testing Agents
  • Metrics & Scoring
  • Evaluation Patterns

• Guides (Audit-suggested)

  • Writing Effective Agent Instructions
  • AgentKit MCP Extension (Moved from Agents section)
  • Production Deployment
  • General Best Practices
  • General Troubleshooting
  • Database Integration (Suggestion)
  • Custom Database Setup (Suggestion)
  • Testing & Debugging (Suggestion)
  • Performance Optimization (Suggestion)

• Error Handling Strategies (Suggestion)

• Architecture Deep Dive (Audit-suggested)

  • Framework Architecture
  • Component Interactions
  • Request Processing Pipeline
  • Context Hierarchy
  • Design Philosophy