Commit Graph

19 Commits

Author SHA1 Message Date
Juan Carlos Radillo Diaz 74e95210f5 Adding information as a tip 2026-09-08 17:59:38 +00:00
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
Atefeh Rajabi a52a2d48a2 docs(workflows): clarify delegation tool naming and task completion behavior in collaboration examples (#1935)
Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-07-07 19:37:32 -05:00
Hyang-Ah Hana Kim af790ae141 docs: update more Go documentation and examples to ADK Go v2 (#1936)
* docs: update ADK Go imports to v2 for core concepts and tutorials

* docs: update ADK Go imports and APIs to v2 for runtime and safety

* docs: update ADK Go imports to v2 for features (workflows, tools, skills, sessions, plugins)

* docs: update ADK Go imports to v2 for operations and integrations

---------

Co-authored-by: Kristopher Overholt <koverholt@google.com>
2026-07-07 18:09:07 -05:00
Toni Klopfenstein e9174a1efe Add ADK Go v2.0.0 documentation and graph workflow examples (#1870)
* adding go getting started to 2.0 docs

* updating graphs docs for go; adding in workflow example go snippets

* Updating HiTL docs for Go 2.0

* updating Go getting started guide for v2

* Updating Routes docs for Go v2

* Updating data handling docs for Go 2.0

* Updating dynamic workflows docs for Go 2.0

* fix(docs): set ADK Go 2.0 GA date on the 2.0 landing page


* fix(docs): standardize ADK Go 2.0 install/import on /v2 @ v2.0.0

* updating announcement banner

* routes snippets updates

* 2.0 install instructions clean-up

* updating collaboration docs for go v2 + new example snippet

---------

Co-authored-by: Karol Piotrowicz <kpiotrowicz@google.com>
2026-06-30 09:27:36 -06:00
Ahmed Samir 81f5a3d384 Update link for Dynamic workflows section (#1851)
Co-authored-by: Joe Fernandez <931947+joefernandez@users.noreply.github.com>
2026-06-22 22:06:53 +00:00
Kristopher Overholt 1c93532ca6 Fix broken external links to adk-python contributing/samples and other internal links (#1773)
* Add link to ignore

* Update links to code samples

* Fix links related to graphs and workflows

* Fix more sample links
2026-05-19 13:53:51 -07:00
Joe Fernandez c5a064e99a chain (#1772) 2026-05-19 13:24:47 -07:00
Kristopher Overholt f4b604260d Fix RequestInput prose to not imply @node is required (#1692)
Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
2026-04-28 16:26:11 -05:00
David Ditzenberger 7f7e59e090 Fix typo: 'notes' to 'nodes' in data-handling.md (#1695) 2026-04-27 20:38:06 -05:00
Kristopher Overholt 0d58537cf3 ADK 2.0 Docs: Replace BaseNode subclassing with @node decorator in dynamic workflow examples (#1680)
* ADK 2.0 Docs: Replace BaseNode subclassing with @node decorator in dynamic workflow examples

* Add retry config to limit link checker CI test
2026-04-22 15:25:26 -07:00
Samarth Nimade 1dc7d2d2fc docs: Override _run_impl instead of run in GetInput (#1679)
The 'run' is marked as @final in BaseNode class's implementation and hence can not be be overridden in the child class. Moreover, there is a method _run_impl() specifically for overriding. 

Overriding run directly bypasses the logic that converts raw return values into Event objects. This causes downstream failures in _track_event_in_context, which expects a valid Event type Object.

The _run_impl is called inside the run method.
The  _run_impl can return any value and this value is appropriately converted to Event Object by run method. 

This change moves the custom logic for GetInput into _run_impl, allowing the base class to correctly wrap the yielded request in an Event object before it is tracked by the workflow loop.
2026-04-22 14:56:23 -07:00
Kristopher Overholt e31c7906ca Update ADK 2.0 docs: fix code examples, alpha to beta, and cleanup (#1675)
* Correct code examples and API references in ADK 2.0 workflow docs

* Update Alpha to Beta

* Remove warning
2026-04-22 06:22:38 -07:00
Joe Fernandez f7ed80bbc6 docs: Update Gemini flash names (#1594)
* docs: home page

* updates based on feedback

* respond to review feedback

* docs: update gemini selector strings to "flash-latest"

* Update homepage.css
2026-04-09 16:14:27 -05:00
Kristopher Overholt 58f3aaebca Replace documentation URLs and paths for adk.dev migration (#1536)
* Replace google.github.io/adk-docs URLs and /adk-docs/ paths with adk.dev

Migrate all hardcoded documentation references to use the new custom
domain. Update root-relative links to remove the /adk-docs/ subpath
prefix since the site will be served from the root of adk.dev.

* Additional fixes
2026-04-01 12:48:27 -05:00
Stephan Müller 0baec3b7fc Fix typo in collaboration.md (#1506) 2026-03-27 17:12:07 -05:00
Joe Fernandez 136deb591e docs: update ADK 2.0 get started code sample (#1469) 2026-03-18 15:48:11 -07:00
Joe Fernandez 227f1e456c fix: fix the input for Get started example (#1462) 2026-03-18 12:31:56 -07:00
Joe Fernandez 4849e6a907 docs: adk2 update (#1457)
* docs: adk2 update

* Update index.md

* Update index.md

* Update data-handling.md
2026-03-18 09:31:44 -07:00