Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions adk.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
Comment thread
jacksonyzj marked this conversation as resolved.
title: Botpress ADK
sidebarTitle: Get started
---

The Botpress Agent Development Kit (ADK) is a developer-first TypeScript framework for building AI agents on the Botpress Platform.

<Card title="Read the full ADK documentation" href="/adk/introduction" icon="book-open" cta="Open the docs">
Setup and configuration, conversations, workflows, tools, testing, the Zai LLM utilities, and the CLI reference.
</Card>
207 changes: 119 additions & 88 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,86 +88,7 @@
{
"group": "ADK",
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.

suggestion: same as above, remove this group from the sidebar

"pages": [
"/adk/introduction",
"/adk/quickstart",
{
"group": "Setting up your agent",
"pages": [
"/adk/setup/configuration",
"/adk/setup/environment",
"/adk/setup/integrations"
]
},
{
"group": "Handling conversations",
"pages": [
"/adk/conversations/setup",
"/adk/conversations/ai-execution",
"/adk/conversations/tools",
"/adk/conversations/messages",
"/adk/conversations/custom-components",
"/adk/conversations/lifecycle",
"/adk/conversations/state"
]
},
{
"group": "Handling longform logic",
"pages": [
"/adk/workflows/create",
"/adk/workflows/steps",
"/adk/workflows/request-notify"
]
},
{
"group": "Actions and triggers",
"pages": [
"/adk/external/actions",
"/adk/external/triggers"
]
},
{
"group": "Working with data",
"pages": [
"/adk/data/tables",
"/adk/data/knowledge"
]
},
{
"group": "Testing and debugging",
"pages": [
"/adk/testing/evals",
"/adk/testing/agent-steps",
"/adk/testing/debugging",
"/adk/testing/scripts"
]
},
{
"group": "LLM Utilities",
"pages": [
"/adk/zai/overview",
"/adk/zai/extract",
"/adk/zai/generate",
"/adk/zai/classify"
]
},
{
"group": "AI-native development",
"pages": [
"/adk/ai-native/skills"
]
},
{
"group": "Advanced",
"pages": [
"/adk/advanced/hitl"
]
},
{
"group": "CLI",
"pages": [
"/adk/cli-reference"
]
}
"/adk"
]
},
{
Expand All @@ -182,7 +103,10 @@
{
"group": "Nodes",
"icon": "square-mouse-pointer",
"pages": ["/studio/concepts/nodes/introduction", "/studio/concepts/nodes/autonomous-node"]
"pages": [
"/studio/concepts/nodes/introduction",
"/studio/concepts/nodes/autonomous-node"
]
},
{
"group": "Cards",
Expand Down Expand Up @@ -504,15 +428,109 @@
},
{
"group": "Hooks",
"pages": ["/webchat/react-library/hooks/use-webchat-client"]
"pages": [
"/webchat/react-library/hooks/use-webchat-client"
]
}
]
}
]
},
{
"group": "Desk",
"pages": ["desk/introduction"]
"pages": [
"desk/introduction"
]
}
]
},
{
"tab": "ADK",
"pages": [
{
"group": "Get started",
"pages": [
"/adk/introduction",
"/adk/quickstart"
]
},
{
"group": "Setting up your agent",
"pages": [
"/adk/setup/configuration",
"/adk/setup/environment",
"/adk/setup/integrations"
]
},
{
"group": "Handling conversations",
"pages": [
"/adk/conversations/setup",
"/adk/conversations/ai-execution",
"/adk/conversations/tools",
"/adk/conversations/messages",
"/adk/conversations/custom-components",
"/adk/conversations/lifecycle",
"/adk/conversations/state"
]
},
{
"group": "Handling longform logic",
"pages": [
"/adk/workflows/create",
"/adk/workflows/steps",
"/adk/workflows/request-notify"
]
},
{
"group": "Actions and triggers",
"pages": [
"/adk/external/actions",
"/adk/external/triggers"
]
},
{
"group": "Working with data",
"pages": [
"/adk/data/tables",
"/adk/data/knowledge"
]
},
{
"group": "Testing and debugging",
"pages": [
"/adk/testing/evals",
"/adk/testing/agent-steps",
"/adk/testing/debugging",
"/adk/testing/scripts"
]
},
{
"group": "LLM Utilities",
"pages": [
"/adk/zai/overview",
"/adk/zai/extract",
"/adk/zai/generate",
"/adk/zai/classify"
]
},
{
"group": "AI-native development",
"pages": [
"/adk/ai-native/skills"
]
},
{
"group": "Advanced",
"pages": [
"/adk/advanced/hitl"
]
},
{
"group": "CLI",
"pages": [
"/adk/cli-reference"
]
}
]
},
Expand All @@ -527,7 +545,10 @@
{
"group": "First steps",
"expanded": true,
"pages": ["tutorial/basics/first-steps/prompting", "tutorial/basics/first-steps/adding-knowledge"]
"pages": [
"tutorial/basics/first-steps/prompting",
"tutorial/basics/first-steps/adding-knowledge"
]
},
{
"group": "Custom logic",
Expand Down Expand Up @@ -603,7 +624,10 @@
"source": "./admin-openapi.json",
"directory": "api-reference/admin-api/openapi"
},
"pages": ["api-reference/admin-api/getting-started", "api-reference/admin-api/concepts"]
"pages": [
"api-reference/admin-api/getting-started",
"api-reference/admin-api/concepts"
]
},
{
"group": "Files API",
Expand All @@ -624,21 +648,28 @@
"source": "./tables-openapi.json",
"directory": "api-reference/tables-api/openapi"
},
"pages": ["api-reference/tables-api/getting-started"]
"pages": [
"api-reference/tables-api/getting-started"
]
},
{
"group": "Runtime API",
"openapi": {
"source": "./runtime-openapi.json",
"directory": "api-reference/runtime-api/openapi"
},
"pages": ["api-reference/runtime-api/getting-started", "api-reference/runtime-api/concepts"]
"pages": [
"api-reference/runtime-api/getting-started",
"api-reference/runtime-api/concepts"
]
}
]
},
{
"tab": "Changelog",
"pages": ["changelog"]
"pages": [
"changelog"
]
}
],
"global": {
Expand Down
Loading