Skip to content

docs(weave): format trace data for Chat view (WBDOCS-1656)#2471

Open
anastasiaguspan wants to merge 1 commit intomainfrom
aguspan/wbdocs-1656-trace-chat-view
Open

docs(weave): format trace data for Chat view (WBDOCS-1656)#2471
anastasiaguspan wants to merge 1 commit intomainfrom
aguspan/wbdocs-1656-trace-chat-view

Conversation

@anastasiaguspan
Copy link
Copy Markdown
Contributor

Summary

Adds a focused how-to for WBDOCS-1656: which call input and output shapes trigger the Chat view in Trace details when logging manually (including via the Service API).

Changes

  • New page: weave/guides/tracking/trace-chat-view.mdx — OpenAI-style messages + choices shape, links to Service API cookbook, Threads Chat behavior, OTel note, and trace display customization.
  • Navigation: entry under Tracing basics in docs.json (after Navigate the Weave Trace view).
  • Cross-links: Navigate the Weave Trace view (Call tab bullet) and Use the Service API to trace cookbook intro.

Sources

  • Existing Service API cookbook (weave_via_service_api.mdx) — canonical payload examples for messages / choices.
  • threads.mdx — Chat view behavior for threads (linked for SDK integration context).
  • otel.mdx — OTel Chat view limitations (linked).

Needs SME verification

  • Confirm whether additional provider-specific shapes are officially supported beyond the OpenAI-style messages / choices pattern documented here (internal discussion referenced Zachary Birenbaum for a full list; this PR documents the pattern already shown in the public cookbook).

WBDOCS-1656


Resume prompt for follow-up: PR: (fill after push). Ticket WBDOCS-1656. SME: verify completeness of recognized chat formats beyond OpenAI-style JSON.

{
  "skill": "author-docs",
  "version": "1.0.0",
  "depends_on": {"style-guide": "1.0.0"},
  "model": "unknown"
}

Made with Cursor

Add trace-chat-view how-to for OpenAI-style inputs/outputs, nav entry, and links from Trace view and Service API cookbook.

Made-with: Cursor
@anastasiaguspan anastasiaguspan requested a review from a team as a code owner April 16, 2026 18:16
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 16, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Apr 16, 2026, 6:19 PM

@anastasiaguspan anastasiaguspan added the author-docs-plugin Docs PRs authored via Cursor author-docs skill label Apr 16, 2026
@anastasiaguspan
Copy link
Copy Markdown
Contributor Author

Sources and decision log

  • Factual pattern (messages / choices): Taken from the existing public cookbook weave/cookbooks/weave_via_service_api.mdx (Simple trace section), which is the same shape the UI comments in code samples reference.
  • Structure: How-to guide (task-oriented) per author-docs Diataxis guidance. Single goal: know how to format logged calls for Chat view.
  • Omitted: An exhaustive list of every provider format Weave recognizes. JIRA/Glean notes that engineering may maintain a longer list; the doc stays aligned with what is already published in the cookbook until SME confirms otherwise.
  • IA: Placed in Tracing basics after Navigate the Weave Trace view so it sits next to trace UI docs.

Resume prompt: Continue from #2471WBDOCS-1656. If SME confirms additional formats, extend trace-chat-view.mdx and keep the cookbook in sync.

@github-actions
Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (1 total)

📄 Pages (1)

File Preview
weave/guides/tracking/trace-chat-view.mdx Trace Chat View

📝 Changed (3 total)

📄 Pages (2)

File Preview
weave/cookbooks/weave_via_service_api.mdx Weave Via Service Api
weave/guides/tracking/trace-tree.mdx Trace Tree
⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: e6d39b9 at 2026-04-16 18:19:50 UTC

@github-actions
Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-aguspan-wbdocs-1656-trace-chat-view.mintlify.app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author-docs-plugin Docs PRs authored via Cursor author-docs skill

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant