learning-adk/mkdocs.yml at main · IvanWeiZ/learning-adk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: Learning ADK
site_description: Go beyond the API surface. Understand what actually happens inside Google's Agent Development Kit.
site_url: https://IvanWeiZ.github.io/learning-adk
repo_url: https://github.com/IvanWeiZ/learning-adk
repo_name: IvanWeiZ/learning-adk
edit_uri: edit/main/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/IvanWeiZ/learning-adk

copyright: >
  ADK v1.27.2 · Built with MkDocs Material

nav:
  - Home: index.md

  - Getting Started:
    - Onboarding Guide: adk/00-onboarding-guide.md
    - Request Lifecycle: adk/01-request-lifecycle.md
    - When to Build What: adk/02-when-to-build-what.md

  - Core Layers:
    - Runners: adk/03-runners.md
    - Agents: adk/04-agents.md
    - Flows: adk/05-flows.md
    - Models: adk/06-models.md
    - Events: adk/07-events.md
    - Sessions: adk/08-sessions.md
    - Tools: adk/09-tools.md

  - Extended Capabilities:
    - Apps & Plugins: adk/10-apps.md
    - Memory: adk/11-memory.md
    - Artifacts: adk/12-artifacts.md
    - Auth: adk/13-auth.md
    - Planners: adk/14-planners.md
    - Evaluation: adk/15-evaluation.md

  - Operations & Safety:
    - Error Reference: adk/16-error-reference.md
    - Concurrency: adk/17-concurrency.md
    - Session Lifecycle: adk/18-session-lifecycle.md
    - Latency Optimization: adk/18b-session-latency-optimization.md
    - Session Security: adk/19-session-security.md
    - Security Checklist: adk/19b-security-checklist.md

  - Patterns & Practices:
    - Best Practices: adk/20-best-practices.md
    - Debugging Guide: adk/20b-debugging-guide.md
    - Advanced Patterns: adk/21-advanced-patterns.md
    - Testing: adk/22-testing.md
    - Testing Context Setup: adk/22b-testing-context-setup.md
    - Testing Examples: adk/22c-testing-examples.md
    - Advanced Internals: adk/23-advanced-internals.md
    - Custom Tools & Toolsets: adk/23b-custom-tools-and-toolsets.md

  - ADK 2.0:
    - Preview: adk/25-adk-2.0-preview.md
    - Patterns: adk/25b-adk-2.0-patterns.md

  - FAQ:
    - FAQ: adk/24-faq.md
    - Custom Use Cases: adk/24b-custom-use-cases.md
    - Message Passing: adk/24c-message-passing-patterns.md

  - Python for ADK:
    - Learning Plan: python/python-for-adk-learning-plan.md
    - Gotchas for Java Devs: python/python-gotchas-for-java-developers.md
    - Asyncio Deep Dive: python/python-asyncio-deep-dive.md
    - Asyncio Advanced: python/python-asyncio-advanced.md
    - Decorators: python/python-decorators-deep-dive.md
    - Metaprogramming: python/python-metaprogramming-deep-dive.md
    - Pydantic Core: python/python-pydantic-deep-dive.md
    - Pydantic Advanced: python/python-pydantic-advanced.md
    - Testing & Mocking: python/python-testing-and-mocking-guide.md
    - Testing Advanced: python/python-testing-advanced.md

  - Reference:
    - Glossary: reference/glossary.md
    - Java to Python Cheat Sheet: reference/java-to-python-cheat-sheet.md