Skip to content

Reapply PR #560: Transcripts documentation rewrite for ADP GA#3

Merged
micheleRP merged 1 commit intomainfrom
reapply-pr560-transcripts-rewrite
Apr 29, 2026
Merged

Reapply PR #560: Transcripts documentation rewrite for ADP GA#3
micheleRP merged 1 commit intomainfrom
reapply-pr560-transcripts-rewrite

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

Summary

This reapplies changes from cloud-docs PR #560 by @micheleRP to the adp-docs repository.

Changes from Original PR

Transcripts documentation rewrite:

  • Rewrote transcripts.adoc with transcript-turn model rather than span hierarchies
  • Updated concepts.adoc with SDK semantic conventions for token costs in USD
  • Expanded transcripts-ui-guide.adoc partial with USD costs, turn counts, and tool invocation metrics
  • Updated ingest-custom-traces.adoc with standalone-ADP terminology

The documentation now focuses on conversation turn analysis with cost calculation and reconstructed-turn handling.

Original PR Details

Testing

  • Build completes successfully
  • All observability pages render correctly
  • Partial includes work properly
  • Turn-based analysis documentation is clear

🤖 Generated with Claude Code

This reapplies changes from cloud-docs PR #560 by @micheleRP:
redpanda-data/cloud-docs#560

## Changes from original PR

**Transcripts documentation rewrite:**
- Rewrote transcripts.adoc with transcript-turn model rather than span hierarchies
- Updated concepts.adoc with SDK semantic conventions for token costs in USD
- Expanded transcripts-ui-guide.adoc partial with USD costs, turn counts, and tool invocation metrics
- Updated ingest-custom-traces.adoc with standalone-ADP terminology

The documentation now focuses on conversation turn analysis with cost calculation and reconstructed-turn handling.

Co-Authored-By: Michele Cyran <micheleRP@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill requested a review from a team as a code owner April 27, 2026 11:25
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 27, 2026

Deploy Preview for redpanda-agentic-data-plane ready!

Name Link
🔨 Latest commit f945f4d
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/69ef47b26ffb0600084afbae
😎 Deploy Preview https://deploy-preview-3--redpanda-agentic-data-plane.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.

@micheleRP micheleRP merged commit de43985 into main Apr 29, 2026
4 checks passed
@micheleRP micheleRP deleted the reapply-pr560-transcripts-rewrite branch April 29, 2026 14:43
micheleRP added a commit that referenced this pull request Apr 29, 2026
Greenfield rewrite of the MCP Servers section for the Agentic Data Plane GA
(2026-06-15). Bundles three master-plan workflows: #3 Create MCP server
(DOC-2111), #9 Register remote/self-hosted MCP (DOC-2117), #10 User-delegated
OAuth for MCP (DOC-2118).

Changes:

* Delete legacy MCP content migrated from cloud-docs (the YAML-pipeline-
  authoring era): mcp/pages/remote/ (13 pages), mcp/pages/overview.adoc,
  mcp/pages/local.adoc, mcp/examples/mcp-tools/ (42 YAML files +
  test-mcp-tools.sh). The cloud-docs equivalents were removed in
  redpanda-data/cloud-docs#562; this is the same cleanup applied to adp-docs
  main, where the migration pre-dated #562.
* Rewrite mcp/pages/index.adoc as the MCP Servers landing — frames managed +
  self-managed backends, lists the four ADP-UI top-level areas, points at
  Cloud Management MCP as a peer.
* Stub the 4 must-ship how-tos (create-server, register-remote,
  user-delegated-oauth, test-tools) + the managed-catalog reference, with
  full outlines and // TODO: markers for live walkthroughs on
  adp-production. Auth section uses the new RemoteMCPConfig auth oneof
  (none / static_key / token_passthrough / service_account_oauth /
  user_oauth); credential_mode and the CredentialMode enum are gone post-
  proto-rewrite.
* Stub the 5 should-ship managed deep-dives (sql, kafka, slack, jira,
  openapi). All follow the shared 7-section structure (what the server does
  -> prereqs -> configure -> test -> auth -> use with agents ->
  troubleshooting). Live-walkthrough TODOs throughout.
* managed-catalog.adoc lists all 27 user-facing managed types from
  apps/aigw/internal/mcp/managed/mcps/*/register_mcp.go, grouped by
  ManagedMCPCategory (AI / AWS / Communication / Database / Google /
  Streaming / Utility), with deep-dive links for the 5 with dedicated pages.
* Update modules/ROOT/nav.adoc — replace the legacy Remote/Local
  subsections with the new flat MCP Servers structure; promote Redpanda
  Cloud Management MCP Server to a peer top-level section.
* Cascade: retarget xrefs in modules/agents/, modules/observability/, and
  modules/ROOT/pages/adp-overview.adoc that pointed at deleted
  mcp:remote/* paths. Targets: mcp:remote/overview.adoc -> mcp:index.adoc;
  mcp:remote/quickstart.adoc + create-tool.adoc -> mcp:create-server.adoc;
  mcp:remote/register-external.adoc -> mcp:register-remote.adoc;
  mcp:remote/oauth-user-delegated.adoc -> mcp:user-delegated-oauth.adoc;
  mcp:remote/monitor-mcp-servers.adoc -> mcp:test-tools.adoc;
  mcp:remote/{patterns,best-practices,scale,troubleshooting}.adoc and
  mcp:overview.adoc -> mcp:index.adoc (no direct equivalents).

Beta target (2026-05-15) is best-effort; firm commitment is GA on
2026-06-15. // TODO: markers throughout will be resolved through live
walkthroughs on adp-production in subsequent commits.

Refs: DOC-2111, DOC-2117, DOC-2118
Plan: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1869185054

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

# Conflicts:
#	modules/observability/pages/concepts.adoc
#	modules/observability/pages/transcripts.adoc
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.

2 participants