Skip to content

docs(adk): create State and Configuration concept pages#449

Open
jacksonyzj wants to merge 29 commits intomasterfrom
feat/adk-new-concept-pages
Open

docs(adk): create State and Configuration concept pages#449
jacksonyzj wants to merge 29 commits intomasterfrom
feat/adk-new-concept-pages

Conversation

@jacksonyzj
Copy link
Copy Markdown

@jacksonyzj jacksonyzj commented Apr 6, 2026

Summary

Two new concept pages for State and Configuration, filling gaps in the ADK documentation.

Tickets

# Ticket Page
1 ADK-304 State
2 ADK-303 Configuration

State page covers

  • Three state scopes: bot (global), user (per-user), conversation (per-conversation)
  • Defining schemas in agent.config.ts and Conversation definitions
  • Reading/writing state in handlers (clarified: only inside runtime context)
  • Tags definition and read/write for bot, user, conversation
  • State references with Reference.Workflow()
  • bot.id and user.id identity accessors

Configuration page covers

  • Full defineConfig reference with all options (including evals)
  • configuration runtime import (read-only proxy)
  • adk config / config:get / config:set with --prod flag (with real CLI output)
  • Environment variables (process.env in agent.config.ts)
  • Note: no dedicated secrets API; integration secrets via dashboard
  • Note: adk config is separate from integration configuration
  • Note: config:get reads persisted values only, not schema defaults
  • Default models, custom events, dependencies

Test plan

  • Preview via Mintlify staging deployment
  • Live tested adk config, config:set, config:get on real bot
  • Verified all internal links resolve

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 6, 2026

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

Project Status Preview Updated (UTC)
botpress 🟢 Ready View Preview Apr 6, 2026, 2:49 PM

@jacksonyzj jacksonyzj marked this pull request as ready for review April 6, 2026 15:52
@jacksonyzj jacksonyzj requested review from a team and aj-botpress April 6, 2026 15:52
Comment on lines +47 to +48
apiKey: z.string(),
maxRetries: z.number().default(3),
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

suggestion: If this snippet is meant to show only the structure of the config file, we should avoid showing specific schemas.

Comment on lines +54 to +55
chat: { version: "chat@0.7.7", enabled: true },
webchat: { version: "webchat@0.3.0", enabled: true },
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Same as above.

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.

just a couple of comments in addition to those already left

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.

4 participants