Skip to content

docs(adk): audit foundations and concept pages#444

Open
jacksonyzj wants to merge 33 commits intomasterfrom
feat/update-adk-docs
Open

docs(adk): audit foundations and concept pages#444
jacksonyzj wants to merge 33 commits intomasterfrom
feat/update-adk-docs

Conversation

@jacksonyzj
Copy link
Copy Markdown

@jacksonyzj jacksonyzj commented Apr 1, 2026

Summary

Audit and update all foundation and concept pages to match ADK v1.17. Verified against runtime source code (agent-lack repo) and shipped @botpress/runtime@1.17.0 types.

Tickets

# Ticket Page
1 ADK-287 Introduction
2 ADK-288 Quickstart
3 ADK-289 Project Structure
4 ADK-292 Conversations
5 ADK-290 Actions
6 ADK-294 Tables
7 ADK-295 Triggers
8 ADK-296 Knowledge
9 ADK-291 Tools
10 ADK-293 Workflows (merged 2 pages → 1)

Key changes

  • Fixed inaccurate code examples and API signatures
  • Removed non-existent APIs and unreleased features
  • Added missing documentation for shipped features
  • Merged the two workflow pages into one
  • Updated quickstart to match current adk init flow

See individual Linear tickets for detailed change lists.

Test plan

  • Preview via Mintlify staging deployment
  • Cross-check all code examples against @botpress/runtime@1.17.0 shipped types
  • Verified all internal links resolve
  • Tested by separate AI agent reading local .mdx files against running ADK bot

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
botpress 🟢 Ready View Preview Apr 1, 2026, 12:29 AM

@jacksonyzj jacksonyzj changed the title docs(adk): update ADK documentation docs(adk): audit existing pages — foundation + concepts (PR 1) Apr 1, 2026
@jacksonyzj jacksonyzj changed the title docs(adk): audit existing pages — foundation + concepts (PR 1) docs(adk): audit foundations and concept pages Apr 1, 2026
@jacksonyzj
Copy link
Copy Markdown
Author

image we should prompt them to open up the control panel earlier.
would be nice to also introduce them to the agentsteps screen here.

Good suggestions! I moved the control panel above adk chat, also include a screenshot for agent steps.

@jacksonyzj
Copy link
Copy Markdown
Author

image Should this be part of project structure?

I put it here as a quick intro since it ties to agent.config.ts. But the full deep dive will be in the dedicated State and Configuration pages which I'm gonna add in the next PR.

Copy link
Copy Markdown
Collaborator

@chloequijano-botpress chloequijano-botpress left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feedback after some of the changes

```bash bun
bun install
```
- `agent.config.ts` — Agent configuration, state schemas, and integration dependencies
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the problem is that this page is more of a "quickstart" so it should just be instructions for getting started quickly instead of needing to read long texts like this. If they want more details they have the Project Structure as the next page

```bash bun
bun install
```
- `agent.config.ts` — Agent configuration, state schemas, and integration dependencies
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ more of an opinion but happy to have someone else jump in if they disagree so I'll have it unresolved for now

Copy link
Copy Markdown
Collaborator

@adkah adkah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice nice!! just need to add dark mode image like i mentioned for your other PR. pretty sure Chloe's comment in quickstart.mdx got resolved, not sure why it's still blocking

ChloeQuijano
ChloeQuijano previously approved these changes Apr 7, 2026
Copy link
Copy Markdown
Collaborator

@chloequijano-botpress chloequijano-botpress left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure why my personal can approve but anyways

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants