Skip to content

docs(adk): rewrite Managing Integrations page - #451

Closed
jacksonyzj wants to merge 15 commits into
masterfrom
feat/adk-integrations-restructure
Closed

jacksonyzj wants to merge 15 commits into
masterfrom
feat/adk-integrations-restructure

Conversation

@jacksonyzj

Copy link
Copy Markdown

Summary

Rewrite the Managing Integrations page to reflect the current ADK integration workflow: string shorthand format in agent.config.ts and configuration via the Control Panel.

Tickets

# Ticket Page
1 ADK-300 Managing Integrations

Key changes

  • Rewrote for string shorthand format (object format deprecated)
  • Added discovery section: adk search, adk list --available, adk info
  • Integration configuration now via Control Panel, not agent.config.ts
  • Added real CLI output examples
  • Added status table for Control Panel cards
  • Added "Using integrations in code" section

Test plan

  • Preview via Mintlify staging deployment
  • Verify all CLI commands match actual output
  • Verify all internal links resolve

@jacksonyzj
jacksonyzj marked this pull request as ready for review April 7, 2026 18:47
@jacksonyzj
jacksonyzj requested a review from adkah as a code owner April 7, 2026 18:47
@mintlify

mintlify Bot commented Apr 7, 2026 •

Copy link
Copy Markdown

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

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

@adkah adkah left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice work, just a few comments

Comment thread adk/managing-integrations.mdx Outdated
Comment thread adk/managing-integrations.mdx
Comment thread adk/managing-integrations.mdx Outdated
Comment thread adk/managing-integrations.mdx
Comment thread adk/managing-integrations.mdx Outdated
Comment thread adk/managing-integrations.mdx
@jacksonyzj
jacksonyzj requested review from a team, aj-botpress and maanav-rajesh April 8, 2026 15:31

@maanav-rajesh maanav-rajesh left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nice work! Just a few comments about the new integrations format

Comment thread adk/managing-integrations.mdx Outdated
## Configuring integrations

You can also update the version it manually:
Integration settings (API keys, tokens, OAuth credentials) are managed in the Control Panel, not in `agent.config.ts`.

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: I think it's worth it to explicitly mention that this is behaviour that changed from before and add a walkthrough of the migration steps in the CLI (the modal that pops up and asks users to switch to the new format)

Comment thread adk/managing-integrations.mdx
Comment thread adk/managing-integrations.mdx Outdated

1. The CLI displays which integrations use the deprecated format
2. You're asked to confirm the migration
3. Integrations without custom configs are automatically converted to string shorthand

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'configs'?

Comment thread adk/managing-integrations.mdx Outdated
1. The CLI displays which integrations use the deprecated format
2. You're asked to confirm the migration
3. Integrations without custom configs are automatically converted to string shorthand
4. Integrations with custom configs need manual updates — move their settings to the Control Panel

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'configs'?

Comment thread adk/managing-integrations.mdx Outdated

1. The CLI displays which integrations use the deprecated format
2. You're asked to confirm the migration
3. Integrations without custom configs are automatically converted to string shorthand

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'configs'?

Comment thread adk/managing-integrations.mdx Outdated
1. The CLI displays which integrations use the deprecated format
2. You're asked to confirm the migration
3. Integrations without custom configs are automatically converted to string shorthand
4. Integrations with custom configs need manual updates — move their settings to the Control Panel

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'configs'?

@jacksonyzj

Copy link
Copy Markdown
Author

Closing: this work is rolled into the ADK docs rewrite PR #459.

@jacksonyzj jacksonyzj closed this Apr 23, 2026

This branch was successfully deployed

1 active deployment
staging — cebce022 Deployed Apr 13, 2026 by mintlify[bot]
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.

3 participants