Align nav labels and page titles#40
Merged
Merged
Conversation
Updates the H1 titles on 15 pages so the page header matches the nav label readers click to reach it. Uses the conversational/customer framing from the prototype where it's clearer, the standard term where the prototype phrasing was awkward, and a merged wording where both perspectives add value. Connect & tools: Managed MCP Server Catalog -> Plug in an App, Database, or Tool Configure User-Delegated OAuth (trimmed "for an MCP Server") Connect Remote MCP Clients (trimmed "to AI Gateway") Monitor & debug: Read a Transcript -> See What Your Agent Did Metrics -> Check Speed, Cost, and Errors Read Violations -> Review Blocked Requests BYOA Telemetry -> Send BYOA Telemetry (OpenTelemetry) Control & govern: Read the Governance Overview -> See All Your Agents in One Place Token Budgets and Limits -> Set Spending Limits and Token Budgets About ADP Permissions -> Control Who Can Do What Routing & LLM settings: AI Gateway Overview -> How AI Gateway Works Reference: Settings reference -> Reference ADP Permissions Reference -> Roles and Permissions Reference Evaluator Types Reference -> Guardrail Evaluator Types Reference rpk Commands -> rpk Command Reference Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Updates 17 nav labels in modules/ROOT/nav.adoc. Keeps the prototype's conversational voice for items where it's clearer (transcripts, metrics, dashboard overview, permissions) and adopts the page-side wording where the standard term reads more directly (Create an Agent, Create an MCP Server, Troubleshoot AI Agents, Guardrails Overview). Also renames the top-level section header from 'Settings reference' to 'Reference' to match the page title and to align with the docs and cloud-docs reference modules. 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. |
The ADP UI used to nest AI Gateway, AI Agents, Remote MCP, Transcripts, and Providers under a top-level 'Agentic' (or 'Agentic AI') parent. That bucket is gone; those sections are now top-level in the sidebar. Strips '*Agentic* > ' and '*Agentic AI* > ' from every body-text breadcrumb so click paths match the current UI. 25 occurrences across 17 files. Examples: *Agentic* > *AI Gateway* > *Gateways* -> *AI Gateway* > *Gateways* *Agentic AI* > *AI Agents* -> *AI Agents* *Agentic AI* > *Remote MCP* -> *Remote MCP* The 'Agentic Data Plane' product name (no bold + no trailing >) is not matched by either pattern and is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
As ADP moves toward a standalone product surface, drop the 'Redpanda Cloud' parent framing from user-facing prose. 13 changes across 7 files: - 'Redpanda Cloud service account' -> 'Redpanda service account' - 'Redpanda Cloud's role-based access control' -> 'Redpanda's RBAC' - 'Redpanda Cloud's OIDC provider' -> 'Redpanda's OIDC provider' - 'Redpanda Cloud's Console' -> 'Redpanda Console' - 'Access to the Redpanda Cloud UI' -> 'Access to the Redpanda UI' - 'Sign in to the Redpanda Cloud UI' -> 'Sign in to Redpanda' - 'Log in to Redpanda Cloud' -> 'Log in to Redpanda' - 'register them as Redpanda Cloud secrets' -> '...as Redpanda secrets' For the quickstart prereqs and bedrock-setup prereq, normalize the phrasing to 'A Redpanda BYOC environment on AWS with ADP enabled'. Kept unchanged: the nine '// TODO:' comments that flag the standalone-ADP rewrite work (the 'Redpanda Cloud' reference there is intentional context for future authors), and the xref label 'Authenticate to Redpanda Cloud' that links to the cloud-docs page of that exact title. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
22 replacements across 8 files. Matches the product's preferred terminology. Only the 'spending limit(s)' phrase is touched; standalone 'spending' words (spending pipeline, spending patterns, spending event, AI spending, the dataplane_adp_spending_* permission identifiers, the JSON field spending_limit_amount) are unchanged. The budgets.adoc page title becomes 'Set Spend Limits and Token Budgets'; the nav label becomes 'Set spend limits'. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Resolves PR #40 open question Q1. The full title 'Set Spend Limits and Token Budgets' was long for an H1; the body intro already explains that budgets and limits are tracked together. The permissions-reference xref drops its explicit label so the link picks up the new title automatically. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…bels Resolves PR #40 open question Q2. The page intro and the :description: attribute already explain that BYOA telemetry uses OpenTelemetry, so the parenthetical in the H1 was redundant. Same treatment for the four cross-link labels in byoa-register.adoc. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Resolves PR #40 open question Q4 plus a Title Case sweep of every nav label. Q4: 'Quickstarts' becomes 'Get Started' to match docs and cloud-docs conventions. New modules/get-started/pages/index.adoc serves as the section landing (':page-layout: index' auto-renders the 4 sub-items as cards). adp-overview.adoc joins as the first sub-item labeled 'Redpanda ADP Overview'. Title Case sweep: every section header and every sub-item now uses Title Case. Sub-items that previously read in sentence case (e.g. 'See what your agent did') align to the page H1 ('See What Your Agent Did'). Three rows also had stale labels that didn't match the new page titles: - 'Plug in any app, database, or tool' -> 'Plug in an App, Database, or Tool' - 'Send telemetry from agents you host' -> 'Send BYOA Telemetry' - 'How the gateway works' -> 'How AI Gateway Works' Title Case rule: capitalize first/last words and major words; lowercase articles (a, an, the), coordinating conjunctions (and, but, or, nor), and short prepositions when not first/last. Exception: 'rpk' stays lowercase (literal command name). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
connect, monitor, control, gateway index pages now match their Title Case nav labels. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Matches the nav sub-item label, so clicking 'Redpanda ADP Overview' under 'Get Started' lands on a page whose H1 reads the same. 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.
Context
PR #39 restructured the modules into workflow-based groupings, with conversational nav labels carried over from the prototype. Page titles still used the older feature-name conventions, so clicking a nav item and landing on a page felt like switching products.
This PR harmonizes the two — meeting in the middle row by row. Some nav labels are clearly stronger (more discoverable, customer-language) so the page title got rewritten to match. Some page titles are clearer/more searchable so the nav label adopted them. A handful naturally combine the two voices into something cleaner than either alone.
Also renames the top-level section "Settings reference" to just "Reference" to match the page title and align with the docs and cloud-docs reference modules.
Changes
Page titles rewritten (nav voice wins)
connect/managed/managed-catalogmonitor/transcriptsmonitor/metricscontrol/guardrails/violationscontrol/dashboard/overviewcontrol/permissions-overviewNav labels rewritten (page voice wins)
connect/create-agentconnect/create-serverconnect/register-remoteconnect/byoa-registerconnect/claude-codemonitor/troubleshoot-ai-agentscontrol/guardrails/overviewcontrol/guardrails/create-guardrailgateway/bedrock-setupreference/rpk-installBoth sides updated (merged wording)
connect/user-delegated-oauthconnect/remote-mcp-clientsmonitor/byoa-telemetrycontrol/budgetsgateway/overviewcontrol/permissions-referencecontrol/guardrails/types-referencereference/rpk/indexreference/index(section header)Follow-up sweeps (later commits on this branch)
After the initial alignment commits, three sweeps landed on the same branch:
Drop the obsolete
AgenticUI breadcrumb prefix (commit 6395069)The ADP UI used to nest AI Gateway, AI Agents, Remote MCP, Transcripts, and Providers under a top-level Agentic parent. That bucket is gone. Stripping
*Agentic* >/*Agentic AI* >from every body-text breadcrumb so click paths match the current UI. 25 occurrences across 17 files. Examples:*Agentic* > *AI Gateway* > *Gateways*→*AI Gateway* > *Gateways**Agentic AI* > *AI Agents*→*AI Agents*Drop "Redpanda Cloud" framing in body prose (commit d077107)
As ADP moves toward a standalone product surface, dropped the "Redpanda Cloud" parent framing from user-facing prose. 13 changes across 7 files. Examples:
Kept unchanged: nine
// TODO:comments that flag standalone-ADP rewrite work (the "Redpanda Cloud" reference there is intentional context for future authors), and the xref label "Authenticate to Redpanda Cloud" that links to the cloud-docs page of that exact title.Rename "spending limit" to "spend limit" (commit 8ff47ff)
22 replacements across 8 files. Matches the product's preferred terminology. Only the
spending limit(s)phrase is touched; standalone "spending" words (spending pipeline, spending patterns, spending event, AI spending,dataplane_adp_spending_*permissions, JSON fieldspending_limit_amount) are unchanged. Thebudgets.adocpage title becomes "Set Spend Limits and Token Budgets" (later trimmed to "Set Spend Limits" per resolved Q1); the nav label becomes "Set spend limits".Open questions (resolved)
All four questions answered and applied in later commits on this branch:
get-started/index.adocsection landing; adp-overview joins as the first sub-item labeled "Redpanda ADP Overview" (commit 7eb3692)Plus a follow-up sweep:
Preview pages
Test plan
npm run buildexits clean (only pre-existing rpk-ai table warnings)/connect/managed/managed-catalog/H1 = "Plug in an App, Database, or Tool"/monitor/transcripts/H1 = "See What Your Agent Did"Out of scope
transcripts.adoc→see-what-agent-did.adoc, etc.). URL slugs stay as-is.🤖 Generated with Claude Code