Commit Graph

74 Commits

Author SHA1 Message Date
Amaad Martin c75e61f5f3 docs: normalize Typescript to TypeScript across the site (#2079)
The site rendered one language under two names. Tab labels were split
137 `TypeScript` / 53 `Typescript`, with three pages carrying both
spellings at once (custom-agents.md 7/7, patterns.md 1/7,
function-tools.md 4/1), and the language-support badges were split 67/18
the same way. Because pymdownx.tabbed slugifies tab labels to lowercase,
both variants rendered and linked fine, so no link check or build warning
ever flagged it -- it was visible only to readers, as two names for one
SDK.

Every user-visible occurrence is normalized to `TypeScript`, plus the two
inconsistencies that turned up while doing it. 80 changed lines, accounted
for exactly:

  53  tab label       === "Typescript"            -> === "TypeScript"
  18  badge span      lst-typescript">Typescript  -> TypeScript
   3  prose mention   cloud-run.md, mcp-tools.md, workflows/patterns.md
   2  api-reference/index.md card heading and link text
   1  badge div attr  title="...Python and Typescript."
   1  mkdocs.yml nav  Typescript ADK              -> TypeScript ADK
   1  code fence      ```javascript -> ```typescript on a .ts include
   1  artifacts/index.md closing summary sentence
  ---
  80

The first six rows are pure casing: 78 lines that differ from their
originals by nothing but `Typescript` -> `TypeScript`. The last two are
not, and are the reason this is not a `sed`:

llm-agents.md:872 fenced `--8<-- ".../capital_agent.ts"` as ```javascript.
It was the only javascript-fenced `.ts` include in docs/ (the other 189
TypeScript fences are correct), and it cost that one snippet its
TypeScript highlighting.

artifacts/index.md:1084 closed the page by naming languages and got the
list wrong. It described reaching the artifact methods "using Python's
context objects or directly interacting with the `BaseArtifactService` in
Java" -- a two-language enumeration at the end of a page that carries
Python, TypeScript, Go, Java and Kotlin tabs (11/10/10/10/11), and one
that contradicts :556, which correctly names four of them. The
enumeration is dropped rather than extended: the sentence now describes
the two ways to reach these methods -- through the context object, or
through `BaseArtifactService` -- which is what the page actually teaches
and does not rot when a sixth language is added.

docs/api-reference/index.md is included even though the rest of
docs/api-reference/ is generated output that must not be touched. That
tree holds 3,140 generated HTML files and exactly one hand-authored page:
this one. It is Markdown, it is the only api-reference entry mkdocs.yml
lists as `.md` rather than `index.html` (:272, :441), it uses Material
`grid cards` and `:fontawesome-*:` shortcodes, and it carries a
`CONTRIBUTORS:` note citing issues #1716 and #1717. Its TypeScript card
already said "TypeScript" twice in its body text while its heading and
link text said "Typescript"; those two are now consistent with the body.
No generated file is modified.

Not in this change: the broken `SseConnectionParams` sample in
mcp-tools.md (docs-ts/p6c-mcp-ts-sample) and the `@google/adk` example
version bumps (docs-ts/p6b-example-versions). Only the casing of the
prose line above that sample is touched here.

Verified: `mkdocs build` exits 0 with an empty warning set on both main
and this branch, and the two warning sets are identical. A rendered
before/after diff of the whole site shows every `__tabbed_*` id, every
tab radio id and every heading anchor unchanged. Zero `=== "Typescript"`
and zero `lst-typescript">Typescript` remain anywhere in the repo.

Co-authored-by: Amaad Martin <amaadmartin@google.com>
2026-08-05 15:58:49 -07:00
Joe Fernandez 9dae39408d docs (python): Python API Reference docs v2.6.0 (#2039)
- generated using https://github.com/google/adk-docs/tree/main/tools/python-api-docs
2026-07-31 13:51:30 -07:00
Kristopher Overholt bc749667a7 Update API reference docs for ADK TypeScript 1.5.0 (#2040) 2026-07-31 18:21:37 +00:00
Joe Fernandez 3e4a9ea715 docs: Update REST API reference to 2.6.0 (#2042)
* git

* docs: Update REST API reference to 2.6.0
2026-07-31 11:20:00 -07:00
Joe Fernandez c7827b6335 git (#2041) 2026-07-31 11:19:06 -07:00
Maciej Szwaja 6f82b62a08 chore: update ADK Java doc to version 1.7.0 (#1989) 2026-07-24 18:22:51 +00:00
Kristopher Overholt 53546fa457 Update ADK Kotlin to 0.5.0 (#1962)
* Regenerate ADK Kotlin 0.5.0 API reference

* Regenerate ADK Kotlin 0.5.0 API reference

* Bump ADK Kotlin version references to 0.5.0
2026-07-15 12:12:30 -05:00
Kristopher Overholt ef2800a51e Update ADK Kotlin to 0.4.0 (#1921)
* Bump ADK Kotlin version references to 0.4.0

* Update ADK Kotlin snippets for 0.4.0 App API

* Regenerate ADK Kotlin 0.4.0 API reference

* Disable pretty URLs in Netlify builds (including preview builds)
2026-07-13 15:53:59 -05:00
Kristopher Overholt f9d462d481 Update CLI reference docs for ADK Python 2.3.0 (#1918) 2026-07-13 15:53:20 -05:00
Maciej Szwaja c5f9b2dcf6 chore: update ADK Java doc to version 1.6.0 (#1938) 2026-07-08 13:34:00 -05:00
Kristopher Overholt 66147d6d61 Update API reference docs for ADK Python 2.3.0 (#1917)
* Update Python API reference docs for ADK 2.3.0

* Add "(Python)" to ADK Python API reference title
2026-07-01 14:53:00 -05:00
Kristopher Overholt 95d55336ee Update REST API reference docs for ADK Python 2.0.0 (#1919) 2026-07-01 13:20:00 -05:00
Joe Fernandez 1b2660a0c0 docs: Update Go API docs references (#1911)
* docs: Update Go API docs references

* respond to review comments
2026-06-30 13:51:50 -07:00
Maciej Szwaja 11b29d256c chore: update ADK Java doc to version 1.5.0 (#1859) 2026-06-23 20:27:56 +00:00
Maciej Szwaja d929044f84 chore: update ADK Java doc to version 1.4.0 (#1810) 2026-06-02 11:00:37 -05:00
Kristopher Overholt 82f734ef69 Update ADK Kotlin to 0.2.0 (#1797)
* Update version for ADK Kotlin to 0.2.0

* Update version for ADK Kotlin examples to 0.2.0

* Update install steps on multi-tool-agent page

* Update ADK Kotlin API reference docs to 0.2.0

* Remove runner parameter from AdkWebServer constructor
2026-05-26 17:06:44 -05:00
Kristopher Overholt c00126981c Add Google Analytics tag to ADK Kotlin API reference docs (#1785)
* Add GA tag injection to Kotlin API docs generation script

- Inject Google Analytics tag into all generated HTML files using awk
- Remove unnecessary gradle prerequisite check (script uses ./gradlew)
- Update prerequisites comment to clarify Android SDK requirement

* Regenerate ADK Kotlin 0.1.0 API docs with Google Analytics tag
2026-05-21 11:20:31 -05:00
Kristopher Overholt 6458159925 Add Python API reference docs and generation script for ADK Python 2.0.0 (#1786)
* Add Python API docs generation script and Sphinx config

* Add Python API reference docs for ADK Python 2.0.0

* Include version and release number in config for built API docs
2026-05-20 15:56:43 -05:00
Kristopher Overholt f87ee60536 Update Python REST API reference docs for ADK 2.0.0 (#1781) 2026-05-20 15:50:03 +00:00
Kristopher Overholt 71854c501d Update CLI reference docs for ADK 2.0.0 (#1780) 2026-05-20 15:30:04 +00:00
Maciej Szwaja 5c92b86646 chore: update ADK Java doc to version 1.3.0 (#1784) 2026-05-20 15:28:32 +00:00
Kristopher Overholt 50f7df7f46 Add Kotlin language support to ADK docs (#1768)
* Add Kotlin to hero / front page

* Add quickstart page for Kotlin

* Complete Kotlin quickstart guide and fix hero code sample (#2)

* Replace GitHub repo links with language icons in header (#3)

* Fix header icon FOUC and homepage font weight regression (#4)

* Testing staging pipeline

* Revert test edit (for staging pipeline)

* Update language icon tooltips to indicate GitHub destination (#5)

* Add link to ADK Kotlin release notes (#7)

* Initial commit of ADK Kotlin API reference docs (#6)

* Add script to generate ADK Kotlin API reference docs (#8)

* Update links and link checker ignore list (temporarily) (#9)

* Add ADK Kotlin for Android getting started guide to Advanced setup page (#10)

* Add advanced setup page with steps to "Use ADK Kotlin in Android projects"

* Update temp link checker rules

* Add placeholder folder for adk-samples (#13)

* adding linter/compilation checks for kotlin snippets (#12)

* adding linter/compilation checks for kotlin snippets

* Add Kotlin validation scripts

* Initial commit of Kotlin sample agents for adk-samples (#15)

* Adding kotlin snippet for llm agents (#16)

* Adding kotlin snippets to  Events (#17)

* Pull changes to docs/events/index.md from glaforge-kotlin-snippets

* fixing kotlin event timestamp and longRunningToolIds

* Fix language tags (#19)

* Fix language tags

* Update

* Fix wrapping

* Fix wrapping (again)

* Fix wrapping/format

* Fix language tag on integration page

* Enable check_paths in PyMdown Snippets Extension to make the build fail if a snippet can't be found (#20)

* Update mkdocs config (#21)

* Fix broken links, update URLs to adk.dev, and improve (temp) lychee config (#22)

* Add Kotlin/maven badge to README (#23)

* Adding Kotlin snippets for artifacts  (#18)

* Pull Kotlin snippets for artifacts from glaforge-kotlin-snippets

* Add comprehensive Kotlin snippets for artifacts

* Refactor artifacts documentation to use external Kotlin snippets

* Update Kotlin model to gemini-flash-latest

* Fix GCS initialization in Kotlin artifact snippet

* afixi failing test with capital-agent added to files_to_check

* Fix snippet label syntax for MkDocs build

* Configure proper Gradle project for Kotlin snippets and fix dependencies

* Add KSP support and generated sources to Kotlin snippets build

* fixing capital_agent turnComplete

* Fix syntax error in build.gradle.kts by removing invalid placeholders (#25)

* Adding Kotlin snippets to google-gemini.md (#27)

Pulling kotlin changes to google-gemini.md from glaforge-kotlin-snippets

* Add a warning about not adding an api key to production code. (#28)

* Add a warning about not adding an api key to production code.

* Update note

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>

* Add ADK Demo App sample showcasing Gemini-powered agents (#29)

This sample demonstrates how to use the Google ADK (Agent Development Kit) in an Android application to create a chat interface powered by a Gemini-based "Fun Facts" agent. The implementation features:
*   Integration with the Kotlin ADK core and processor libraries.
*   A `FunFactsAgent` defined using `LlmAgent` and the Gemini model.
*   A `ChatViewModel` utilizing `InMemoryRunner` for asynchronous message streaming.
*   A modern UI built with Jetpack Compose and Material 3.
*   Build configuration logic for secure API key management via environment variables or `local.properties`.

* Update Kotlin docs and samples to align with adk-kotlin API changes (#30)

Rename GeminiModel to Gemini, @AdkTool/@AdkParam to @Tool/@Param,
adkTools() to generatedTools(), replace DebugRunner with InMemoryRunner,
fix AgentLoader import path, use SingleAgentLoader, bump Kotlin to
2.3.21 and KSP to 2.3.7, and update Android minSdk from 24 to 26.

* adding kotlin info to READMEs (#14)

* Reorganize Android sample agent and add READMEs (#31)

* Move Android sample agent

* Update repo README, add Android README, update sample agent README

* Minor edit to language support tags (#32)

* Remove blog post link (#33)

Will re-add after it's published

* Remove examples link (#34)

* Adding Kotlin snippets for Sessions docs (#26)

* initial kotlins snippets additions to sessions docs

* Updating memory docs with kotlin snippets

* Adding kotlin snippets to session state docs.

* update model to gemini-flash-latest

* sessions examples clean-up

* fixing sessions snippet markers

* adding kotlin session snippets to files to test

* adding callback to memory_example

* Fixing capital agent snippet  (#35)

Fixing file name
Updating adkTool > Tool
Updating GeminiModel > Gemini

* Adding kotlin snippets for tools docs (#36)

* adding function tool kotlin snippets

* adding function_tools snippets to files to test

* Adding kotlin snippets to observability docs (#37)

* initial kotlin observability updates

* adding observability snippets to file check (#38)

* Adding Kotlin snippets to Callbacks docs (#39)

*  kotlin callbacks snippets

* adding callbacks snippets to file check

* Align Kotlin and KSP versions with published 0.1.0 artifacts (#40)

* switch CLI entry points from InMemoryRunner to ReplRunner (#41)

* Switch CLI entry points from InMemoryRunner to ReplRunner

* Fix wording

* Update API reference docs for Kotlin, 2026-05-18 (#42)

* Remove ADK on Android note until published (#43)

* Update Kotlin code samples (#44)

* Rename GeminiModel to Gemini in Kotlin snippets and docs

* Remove broken SessionKey call and use sessionId directly in AgentTool snippet

* Rewrite Go hero snippet to use llmagent API

* Use isFinalResponse with safe access in CapitalAgent snippet

* Use Role.USER constant instead of raw string in SetupExample

* Use full semver v0.1.0 in Kotlin language support tags

* Remove Android setup steps, moving to new property (#45)

* Tutorial Kotlin agent (#46)

* Adding multi-tool-agent snippet and updating tutorial
* Fixing Go language order on tutorial page
* adding multi tool agent example to files to test

* Inline Kotlin get-started code sample

* Kotlin Multi agents snippets (#47)

* Multi-agent kotlin snippets

* Fixing docs tags in multiagent example

* Fix Kotlin language support tags, code samples, and google-gemini.md cleanup (#48)

* Add Kotlin v0.1.0 to language support tags across docs

* Fix MultiToolAgent.kt model string and argument style

* Update MultiAgentExample.kt to use gemini-flash-latest model string

* Fix google-gemini.md: add Kotlin sample, remove unsupported Java tabs

* Remove explicit apiKey from CallbackBasic.kt for consistency

* Standardize Gemini() constructor to use named args in all snippets

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Remove adk-samples directory (moved to google/adk-samples#1969) (#49)

* Update API reference docs for ADK Kotlin 0.1.0 (#50)

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Update API reference docs for ADK Kotlin 0.1.0

* Remove kotlin lycheeignore config (#51)

* Remove adk-samples directory (moved to google/adk-samples#1969)

* Remove Kotlin .lycheeignore config links

---------

Co-authored-by: Toni Klopfenstein <2359976+ToniCorinne@users.noreply.github.com>
Co-authored-by: Jolanda Verhoef <JolandaVerhoef@users.noreply.github.com>
2026-05-19 11:43:42 -05:00
Kristopher Overholt 2392b4231e Update Python REST API reference docs for ADK 1.33.0 (#1751) 2026-05-13 17:56:02 -05:00
Kristopher Overholt 47896dd850 Update CLI reference docs for ADK 1.33.0 (#1752) 2026-05-13 17:55:28 -05:00
Joe Fernandez 50a959037b docs: Update reference to Python API 1.31.1 (#1722)
* docs: Update reference to Python API 1.31.1

* fix value quotes
2026-05-05 08:52:54 -07:00
Kristopher Overholt 54a226128a Update CLI reference docs for ADK 1.32.0 (#1723) 2026-05-04 17:33:43 -05:00
Kristopher Overholt 9d6d02b291 Update Python REST API reference docs for ADK 1.32.0 (#1724) 2026-05-04 17:33:26 -05:00
Kristopher Overholt 6227f2821b Use absolute URLs for API reference links to prevent broken llms.txt links (#1717) 2026-05-04 15:33:40 -05:00
Maciej Szwaja d6dffcfab3 chore: update ADK Java doc to version 1.2.0 (#1688)
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-04-27 12:18:51 -05:00
Kristopher Overholt 7d55e35bf4 Update Python API reference docs for ADK 1.31.0 (#1663) 2026-04-21 01:21:34 -07:00
Kristopher Overholt 32fe745055 Update CLI reference docs for ADK 1.31.0 (#1657) 2026-04-17 15:24:39 -05:00
Kristopher Overholt c5c960be1e Update Python REST API reference docs for ADK 1.31.0 (#1658) 2026-04-17 15:07:51 -05:00
Kristopher Overholt 20ddbbef70 Update Python REST API reference docs for ADK 1.29.0 (#1619) 2026-04-09 17:58:54 -05:00
Kristopher Overholt ed4311f375 Update CLI reference docs for ADK 1.29.0 (#1615) 2026-04-09 17:39:21 -05:00
Maciej Szwaja 08bbf42b77 chore: update ADK java doc to version 1.0.0 (#1515)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-03-30 08:56:22 -07:00
Kristopher Overholt 59f95269ea Update CLI reference docs for ADK 1.28.0 (#1504)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-03-27 11:21:38 -05:00
Kristopher Overholt d984373662 Autogenerate Python REST API reference docs from FastAPI OpenAPI spec (#1500)
* Auto-generate Python REST API reference docs from FastAPI OpenAPI spec

* Fix link and llmstxt config

* Generate REST API docs with web=False

* Use simpler BaseLayout for generated REST API docs
2026-03-27 10:56:19 -05:00
Maciej Szwaja dd87ab44f5 chore: update ADK Java javadocs to 1.0.0-rc.1 (#1476)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-03-24 09:58:26 -07:00
Maciej Szwaja ca0dd9c321 chore: update adk java javadocs to 0.9.0 (#1432) 2026-03-13 18:30:55 +00:00
Joe Fernandez e77aefc5c7 docs: Update Python API reference to 1.27.0 (#1431) 2026-03-13 13:01:01 -05:00
Scott Mansfield eb110806b9 Updating Typescript docs for 0.5.0 release (#1430) 2026-03-13 10:19:10 -07:00
Maciej Szwaja e343f61088 chore: update adk-java javadoc to version 0.8.0 (#1400)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-03-06 14:25:17 -08:00
Kristopher Overholt 4cea2f4295 Update CLI reference docs for ADK 1.26.0 (#1378) 2026-02-27 11:06:42 -06:00
Maciej Szwaja d5afe520e1 chore: update adk-java javadocs to version 0.7.0 (#1379) 2026-02-27 08:40:13 -08:00
Joe Fernandez 2820f36020 docs: Python v1.26.0 API Reference docs (#1377) 2026-02-27 09:10:03 -06:00
Guillaume Laforge 05f9948a87 chore: Update the JavaDocs to version 0.6.0 of ADK Java (#1368)
* doc: Reference version 0.5.0 of ADK for Java

* doc: Update references of version 0.6.0 of ADK for Java instead of older versions

* chore(javadoc): Update JavaDocs to v0.6.0 of ADK for Java

* chore: update HTML header to add Google Analytics

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-02-26 18:15:18 -08:00
Joe Fernandez 8a6f2bc5b8 update: version number (#1311) 2026-02-12 18:57:40 -08:00
Kristopher Overholt 020396655b Update CLI reference docs for ADK 1.25.0 (#1308) 2026-02-12 17:37:05 -06:00
Kristopher Overholt 792e3a56be Update CLI reference docs for ADK 1.24.1 (#1268) 2026-02-09 12:51:10 -06:00
Joe Fernandez f984bb9276 docs: update Python API Reference docs to v1.24.1 (#1267) 2026-02-06 14:34:52 -08:00