final audit of ADK docs#464
Merged
jacksonyzj merged 14 commits intoaj/adk-docs-updatefrom Apr 23, 2026
Merged
Conversation
Audited each ADK section against the agent-lack source repo and the skills repo. Fixed incorrect content, documented missing features, tightened prose, removed trailing nav Cards, and refreshed dev console screenshots. Corrections: - CLI reference: added --profile global flag, corrected --format availability, added subsections for adk search, adk mcp, adk telemetry, adk theme - HITL: switched integration deps to string shorthand (object form is deprecated), reworded dev-mode warning to match the real constraint - Skills: matched install command args to source (-a codex claude-code), added adk_init_project to the MCP tools table - Evals: fixed Eval import path (@botpress/runtime -> @botpress/adk) and evals directory (src/evals -> evals), documented event/ expectSilence turns and idleTimeout - Debugging: removed bogus 'adk logs "webhook"' content-filter example, added since= and limit= tokens - Scripts: updated flag pass-through example to use -- separator - Actions: fixed callAction curl (chat.botpress.cloud -> api.botpress.cloud, added Authorization header) - Triggers: removed incorrect client parameter from handler table Documented missing features: - Tables: computed columns, \$options regex modifier, keyColumn, waitComputed - Actions: cached prop - Knowledge: search() method, Directory source options, description role - Zai: summarize format/intermediateFactor/sliding, answer() response types, rate() multi-criteria, group() initialGroups/maxGroups Flow and structure: - Rewrote evals with cleaner ordering - Restructured knowledge page with dev console inlined after Create - Moved action-vs-tool comparison to the asTool subsection - Tightened intros on knowledge and actions pages - Inlined dev console mentions into Create sections across pages - Removed trailing next-page Cards from nearly every page Screenshots updated: actions, agent-steps, evals, knowledge, logs, tables, traces, triggers. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
…ctions Continues the audit pass. Fixed inaccuracies, documented missing features, tightened prose, inlined dev console mentions, and refreshed screenshots. Workflows: - Added state prop, workflow.fail, workflow.execute - Added step.progress, noted getOrCreate default statuses - Rewrote ambiguous step-name uniqueness paragraph - Updated request.workflow.provide examples to pass request.step - Inlined workflow dev console mention into Create section Conversations: - Fixed tools title casing (Define Tools -> Define tools) - Clarified customComponent vs custom message types - Added execute() signal? prop (AbortSignal cancellation) - Noted nudge.interval default and max-unlimited behavior - Replaced Chat page screenshot with agent-steps screenshots - Fixed webchat integration install note (no auto-prompt) - Replaced duplicated Traces blurb with link to debugging page Setup: - Fixed swapped default model claim in configuration - Fixed evals.idleTimeout unit (seconds -> milliseconds) - Title casing: Agent Configuration / Environment Setup -> sentence case - Removed evals row pointing at src/evals, updated to evals/ - Trimmed project structure table to core files only - Reworked integrations install vs configure framing - Enable/disable example now leads with string shorthand - Inlined secrets and config dev console mentions into existing sections Screenshots refreshed: workflows, environment selector, secrets, config variables, integrations hub, integration config. Removed trailing next-page Cards from every page in these sections. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
adk/testing/scripts.mdx|46 col 79| [Vale.Spelling] Did you really mean 'args'?
adk/testing/scripts.mdx|46 col 121| [Vale.Spelling] Did you really mean 'args'?
adk/zai/classify.mdx|20 col 26| [Vale.Spelling] Did you really mean 'boolean'?
| </Info> | ||
|
|
||
| HITL (Human-in-the-Loop) lets your agent hand off a conversation to a live human agent. This is powered by two dependencies working together: the **HITL integration** (provides the transport to a helpdesk or agent platform) and the **HITL plugin** (provides the actions your code calls). | ||
| HITL (Human-in-the-Loop) lets your agent hand off a conversation to a live human agent. It's powered by two dependencies working together: the **HITL integration** (the transport to a helpdesk or agent platform) and the **HITL plugin** (the actions your code calls). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'helpdesk'?
| }) | ||
| ``` | ||
|
|
||
| ## Organize evals |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'evals'?
|
|
||
| ## Organize evals | ||
|
|
||
| Evals have two organizing fields that pair with CLI filters: `tags` and `type`. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Evals'?
|
|
||
| Evals have two organizing fields that pair with CLI filters: `tags` and `type`. | ||
|
|
||
| **Tags** are free-form labels. Use them to group evals you want to run together (smoke tests, critical paths, slow suites): |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'evals'?
| adk evals --tag smoke # Run only evals tagged "smoke" | ||
| ``` | ||
|
|
||
| **Type** marks what the eval is for: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'eval'?
| adk evals --type regression # Run only regression evals | ||
| ``` | ||
|
|
||
| ## Run evals |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'evals'?
Incorporates PR #461 (adrian-kahali): - Get Started restructure: welcome -> introduction, new top-level quickstart, updated docs.json sidebar - Configuration page: <Tip> blocks linking to related guides, expandable config snippet, cleaner prose - Environment setup: consolidated secrets + config explanations, better wording - Integrations: clearer intro, CLI section labelled - Conversations: <CodeGroup> for channel matching, <Tip> blocks for cross-references - AI execution: <Note> for LLMz reference, tighter phrasing - Tools: highlight annotations on code blocks Conflicts resolved in favor of keeping the audit fixes from this branch (correct default model order, ms units for idleTimeout, evals/ path, agent-steps screenshot, no trailing Cards, no standalone Dev console sections, "Botpress Cloud" wording, real CLI reference secrets table instead of placeholder link) while taking Adrian's <Tip>/<Note> block styling and structural improvements. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
jacksonyzj
changed the title
| - Chat with your agent | ||
| - Browse its components (actions, workflows, triggers) | ||
| - Manage data (tables, knowledge bases, files) | ||
| - Run evals |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'evals'?
| ## Arguments | ||
|
|
||
| Extra arguments after the script path are passed to your function: | ||
| Extra arguments after the script path are passed to your function. Positional args pass through directly; put flag-like args (anything starting with `-`) after a `--` separator so Commander doesn't try to parse them: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'args'?
| ## Arguments | ||
|
|
||
| Extra arguments after the script path are passed to your function: | ||
| Extra arguments after the script path are passed to your function. Positional args pass through directly; put flag-like args (anything starting with `-`) after a `--` separator so Commander doesn't try to parse them: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'args'?
| // true | ||
| ``` | ||
|
|
||
| Call `.result()` for the boolean plus the LLM's reasoning: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'boolean'?
Introduction: - Tightened intro paragraph - Added Custom components to primitives table - Dropped src/ qualifier since evals live at the project root Quickstart: - Swapped em-dash for colon in the requirements list - Dropped filler sentence at the top of Test your agent - Removed the 'Chat in the terminal' section so readers land in the dev console - Normalized smart apostrophe Refreshed welcome and quickstart screenshots.
adkah
approved these changes
Apr 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audited each ADK section against the latest source, fixed inaccuracies, and documented features that had shipped but weren't in the docs. Updated tone and flow to better match the docs style, and refreshed the dev console screenshots across pages.