Skip to content

docs: rewrite AI Gateway for ADP GA release#559

Open
micheleRP wants to merge 1 commit intomainfrom
adp-ai-gateway-rewrite
Open

docs: rewrite AI Gateway for ADP GA release#559
micheleRP wants to merge 1 commit intomainfrom
adp-ai-gateway-rewrite

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented Apr 21, 2026

Tracks: DOC-2109 — Configure your LLM provider (ADP Docs Plan Workflow #1)

Summary

  • Replace the obsolete AI Gateway page set with a four-page structure (index + overview + configure-provider + connect-agent) matching the ai-agents/agents/ convention. Content is grounded in llm_provider.proto and the adp-ui form labels.
  • Add page aliases so every old URL (what-is-ai-gateway, gateway-quickstart, admin/setup-guide, builders/connect-your-agent, cel-routing-cookbook, mcp-aggregation-guide, builders/discover-gateways, gateway-architecture) 301s to its natural successor.
  • Flag every standalone-ADP detail (sign-in URL, IAM model, OIDC endpoints) with // TODO: pending live-environment verification — ADP is moving to its own product surface rather than nesting under Redpanda Cloud, and concrete URLs/IAM paths aren't finalized yet.

Context

Planning and scope: AI Gateway docs rewrite — ADP GA (2026-06-15) plan (Confluence). Parent workstream: ADP Docs Plan — Beta May 15 / GA June 15.

This is the first pass — the draft is ready for early review of structure and framing, but the // TODO: markers indicate content that needs verification against the live standalone ADP environment when it's available. More rounds of iteration to come before GA.

Preview pages

Test plan

  • Netlify preview builds successfully
  • AI Gateway section renders with four entries in nav (AI Gateway / Overview / Configure an LLM Provider / Connect Your Agent)
  • Spot-check each of the eight redirect aliases resolves correctly on the preview
  • Live-environment walkthrough for each of the five provider types (OpenAI, Anthropic, Google, Bedrock, OpenAI-compatible) once the standalone ADP UI is available — TODO markers identify the gaps
  • Technical SME review for proto field accuracy (team-ai)
  • Final docs-team-standards:review editorial pass before GA
  • Remove the adp-la.adoc partial includes at GA (ADP ships as GA, not LA)

🤖 Generated with Claude Code

The AI Gateway feature was fully rewritten upstream for the ADP
2026-06-15 GA, and today's pages describe an obsolete architecture
(gateway-as-resource, AI Hub / Custom modes, CEL routing rules, MCP
aggregation at the gateway, gateway discovery).

Replace the page set with a structure matching ai-agents/agents/:

- index.adoc (thin landing)
- overview.adoc (conceptual, absorbs what-is-ai-gateway.adoc and all
  deleted-concept aliases)
- configure-provider.adoc (primary how-to, grounded in llm_provider.proto
  and adp-ui form labels)
- connect-agent.adoc (client-side how-to)

Page aliases redirect every old URL to its natural successor. UI
specifics that depend on the upcoming standalone ADP product surface
(sign-in URL, IAM model, OIDC endpoints) are marked with // TODO: for
the live-environment verification pass.

Planning: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1862598662

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner April 21, 2026 21:40
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 21, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 75d0c9f
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69e7eeec6a4f7f000810f313
😎 Deploy Preview https://deploy-preview-559--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 21, 2026

📝 Walkthrough

Walkthrough

This PR restructures the AI Gateway documentation by consolidating extensive multi-page guides into a simplified documentation set. Eight documentation pages covering setup workflows, architecture, CEL routing patterns, MCP aggregation, quickstart, discovery workflows, and conceptual overviews are removed, while three new pages focused on overviewing AI Gateway, configuring LLM providers, and connecting agents are introduced. The navigation structure is correspondingly simplified, and the index page description is updated to emphasize Redpanda as a managed LLM API proxy.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

Suggested reviewers

  • birdayz
  • paulohtb6
  • weeco
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description does not follow the required template structure and is missing critical required fields. Add the missing required sections from the description template: issue number link (Resolves #), Review deadline, and Page previews with proper formatting. Reformat to match the template structure.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: rewrite AI Gateway for ADP GA release' clearly and concisely summarizes the main change—a documentation rewrite of AI Gateway aligned with the ADP GA release.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch adp-ai-gateway-rewrite

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant