Reorder overview for admin-then-user flow; standardize ADP UI naming#37
Merged
Conversation
Move the overview page from modules/ROOT/pages/index.adoc to modules/get-started/pages/adp-overview.adoc (Antora redirects the component root to the new start_page, so the homepage URL is unchanged). Reorder its sections to follow the admin-then-user journey (AI Gateway, MCP servers, AI agents, Governance) and fold Transcripts into the existing "Complete observability" bullet under built-in controls. Replace the bare "Next steps" list with just the two quickstart entry points, since the body text already links to every component overview. Harmonize the AI Agent Quickstart Prerequisites to lead with the same BYOC-on-AWS-with-ADP-enabled line as the ADP Quickstart, and link the ADP Quickstart from the Next steps of both the AI Agent Quickstart and the AI Gateway Quickstart. Replace "ADP UI" with "Agentic Data Plane UI" across the repo (46 instances in 30 files). Lowercase adp-ui code-path references are not touched. Replace one stray glossterm:Redpanda Console[] in the overview, which pointed at the standalone Console product rather than the ADP UI. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Strip prose suffixes from bullets where the target page H1 already carries the meaning, drop bullets that point back up the IA from a deeper page (system-prompts, monitor, troubleshoot-ai-agents, and architecture-patterns all linked back to the parent overview from end-of-page Next steps), and dedup a duplicate xref in architecture-patterns. Restructure the prose-heavy Next steps on mcp/overview.adoc into bare-xref bullets, and drop the post-tutorial prose Next steps on github-oauth-tutorial.adoc whose targets are already covered by the Related topics section beneath. Fix three broken xref targets that surfaced during the audit: xref:mcp/remote/overview.adoc (a phantom target that never existed) across 8 integration admin partials becomes xref:integrations:remote-mcp-clients.adoc; and the wrong-syntax xref:ai-gateway/observability-logs.adoc and observability-metrics.adoc across 4 observability partials become the correct xref:observability:logs.adoc and observability:metrics.adoc. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rename the three identically-labeled "Quickstart" nav entries to ADP Quickstart, AI Agent Quickstart, and AI Gateway Quickstart so the TOC distinguishes them. Fix accuracy issues uncovered while reviewing: agents/quickstart.adoc had page-topic-type: tutorial and linked to a nonexistent "Remote MCP Quickstart" page; both corrected. Apply docs-team-standards audit findings (no future tense, no quotation-mark emphasis, no bold column headers, no directional refs, SSL → TLS). Repair broken test-quickstart and test-console-auth scripts in package.json. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
modules/ROOT/pages/index.adoctomodules/get-started/pages/adp-overview.adoc(Antora's start_page redirect keeps the homepage URL/agentic-data-plane/unchanged).ADP UIwithAgentic Data Plane UIacross 30 files (46 occurrences). Lowercaseadp-uireferences in code paths (apps/adp-ui/src/routes/...) are untouched. The one strayglossterm:Redpanda Console[]in the overview (which pointed at the standalone Console product, not the ADP UI) becomes plain text.Preview pages
Test plan
npm run buildcompletes with no new errors or warnings beyond the pre-existing ones in auto-generated rpk files and cross-repo aggregations/agentic-data-plane/renders the moved overview (start_page redirect)/agentic-data-plane/get-started/adp-overview/renders with sections in the new order🤖 Generated with Claude Code