docs: split the quickstart into admin and agent-builder quickstarts (DOC-2342) - #146
Merged
Conversation
…DOC-2342) Split the combined quickstart into two audience-scoped pages: - adp-quickstart.adoc becomes the administrator quickstart (same URL and aliases): Anthropic key, provider setup with inline secret, verification, and a new hand-off section for builders. - New get-started/pages/agent-builder-quickstart.adoc for builders whose org is already set up: sign in, explore the agent registry, create the PetStore MCP server and agent, test in the Inspector, iterate, verify in the Transcripts tab, then a "Make it real" section pointing at the managed catalog. External-tool and CLI paths are next-steps links. - Nav lists both quickstarts (builder first); home pathway 1 and the builder-context xrefs (monitor-agents, agents-overview, concepts, system-prompts) retarget to the builder quickstart; adp-overview and the get-started index link both. Builder flow verified end-to-end on adp-production 2026-07-20 via rpk ai (OpenAPI MCP server from the PetStore spec, tool generation, live tool calls, A2A agent responses). Co-Authored-By: Claude Fable 5 <[email protected]>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Drop the changeable count from the builder page's "What you build" intro. - Reword the CLI next-step to a statement instead of a rhetorical question. - Sharpen the admin page's third learning objective to name the action. Co-Authored-By: Claude Fable 5 <[email protected]>
Verified the MCP server create flow and detail page against ai.redpanda.com and cloudv2 origin/main, and fixed stale UI labels: - List-page button that opens the create flow is "Add MCP server"; the form's submit button is "Create server" (the two were swapped). - The OpenAPI form field is "Base URL" (not "Base URL override") and the toggle is "Enable Code Mode" (not "Code mode"). - The server detail URL is labeled "MCP Server URL" on the Overview tab (never "API URL"). Corrected across the quickstart, create-server, the OpenAPI/Jira/SQL/Kafka/Slack managed pages, and remote-mcp-clients. The Inspector-tab tool-list step and the generated tool names (findpetsbystatus, getpetbyid, findpetsbytags, addpet, lowercased from the spec's operationId values) were verified accurate and left unchanged. Co-Authored-By: Claude Fable 5 <[email protected]>
In the Create agent Tools section, the "Add MCP server" link opens the server-creation flow in a new tab; it does not attach an existing server. To use a server you already created, search for it in the "Search MCP servers" box and select its checkbox. Verified against the New managed agent form on adp-production. Co-Authored-By: Claude Fable 5 <[email protected]>
The inline API-key secret field does not auto-uppercase the name (only the standalone Secrets Store form does), so tell the reader to use UPPER_SNAKE_CASE themselves. Also note that the Secret value field appears only after the name is entered. Verified against secret-selector-parts.tsx on cloudv2 origin/main. Co-Authored-By: Claude Fable 5 <[email protected]>
Resolve create-server.adoc conflict: keep the MCP Server URL and Create server relabels, and include the new Activity tab step from main. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Admin quickstart: verify the provider on the Overview tab; add a step to enable Record inputs and Record outputs so builders get full transcripts. Agent builder quickstart: correct the Cost & Usage tab description; mark required fields with an asterisk; use claude-haiku-4-5 with the model-first picker; note that transcript recording is off by default; fix the OpenAPI auth mode label to No Auth. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
…n labels - openapi.adoc: auth table uses the create-form labels (No Auth, API Key, User OAuth) - quickstarts: remove the + glyph from button labels for consistency with create-server Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
…rface external-tool paths - Reframe the intro to orient someone new to Agentic Data Plane, with a link to the overview. - Lead Prerequisites with a provider callout that gives a clear fork to the administrator quickstart. - Add a 'Use your agent beyond the UI' section (chat client, A2A, Teams) and trim Next steps. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
JakeSCahill
reviewed
Jul 23, 2026
JakeSCahill
left a comment
JakeSCahill
left a comment
Contributor
There was a problem hiding this comment.
Reviewed this against the docs standards — nothing blocking. All the xrefs, anchors, and images check out on the branch, and the API URL → MCP Server URL cleanup didn't leave any stragglers anywhere in the repo. Left a few small suggestions inline.
JakeSCahill
self-requested a review
July 23, 2026 16:18
JakeSCahill
approved these changes
Jul 23, 2026
- Use a single model (claude-sonnet-4-6) across both quickstarts for reliable tool use. - Add a fallback note for orgs on a non-Anthropic provider. - Builder: lead the intro with the outcome, fix the Teams wording (personal chat, not channel), standardize the sidebar phrasing, trim a redundant PetStore sentence, and use bare xrefs in Next steps. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Splits the combined Agentic Data Plane quickstart into two audience-scoped quickstarts, per DOC-2342 and section 7 of the Package 3 doc plan.
get-started/pages/adp-quickstart.adoc→ Quickstart for Administrators (same URL and page-aliases)platform_engineer.New:
get-started/pages/agent-builder-quickstart.adoc— Quickstart for Agent Buildersagent_builder.Link wiring
monitor-agents,agents-overview,concepts, andsystem-promptsretarget to the builder quickstart.adp-overviewand the Get Started index link both.🤖 Generated with Claude Code
Preview pages
Entry point: Get Started (both quickstarts are linked in the nav: Quickstart for Agent Builders is new, Quickstart for Administrators is the reworked existing page).
Canonical pages whose flow changed in this PR: