docs(weave): consolidate trace-to-run page into weave-in-workspaces - #3032
docs(weave): consolidate trace-to-run page into weave-in-workspaces#3032dbrian57 wants to merge 1 commit into
Conversation
Merge 'Link a W&B run to trace function calls' into 'Use Weave with W&B training runs'. Both pages documented the same Weave trace <-> W&B run integration with overlapping concepts and code examples, and neither linked to the other. - Add 'View a linked run in the Traces table' section covering the content unique to the removed page, referencing the existing canonical training example - Carry over trace-linking keywords to the merged page frontmatter - Remove weave/guides/tracking/trace-to-run.mdx and its English nav entry (fr/ja/ko copies left for the translation pipeline) - Redirect /weave/guides/tracking/trace-to-run to /weave/guides/tools/weave-in-workspaces Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Sources and decision logSources. No new technical claims were authored in this PR — all content was moved or condensed from the two existing pages, verified against the live site before editing:
Decisions.
Needs SME verification
|
Resume prompt
|
Readability impactWord-weighted Flesch-Kincaid grade change across 1 changed page: -0.4 (easier). Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR. Human readability
AI agent comprehensionRated 0-3 (higher is easier for an agent to parse and act on).
Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4. |
{
"skill": "author-docs",
"version": "1.0.0",
"depends_on": { "style-guide": "1.0.0" },
"skills_invoked": [],
"model": "claude-fable-5"
} |
📚 Mintlify Preview Links📝 Changed (2 total)📄 Pages (1)
⚙️ Other (1)
🗑️ Deleted (1 total)View deleted files📄 Pages (1)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 Link Checker Results✅ All links are valid! No broken links were detected. |
What changed
Consolidates two Weave docs pages that documented the same Weave trace ↔ W&B run integration:
weave/guides/tracking/trace-to-run.mdx("Link a W&B run to trace function calls", ~400 words)weave/guides/tools/weave-in-workspaces.mdx("Use Weave with W&B training runs") with a new View a linked run in the Traces table section placed between "Use Weave panels" and "Associate traces with a specific W&B run"/weave/guides/tracking/trace-to-run→/weave/guides/tools/weave-in-workspaces(same pattern as the earliertrace-agent-integrationsmerge)docs.jsonentry; carried the trace-linking keywords (wandb.init,trace linking,experiment tracking) into the merged page's frontmatterWhy
weave.init()+@weave.op+wandb.init()+run.log()), which invites drift.set_wandb_run_context()or the Traces-table view, respectively.Reviewer notes
fr/,ja/, andko/copies and their nav entries are intentionally untouched, per AGENTS.md ("avoid editing localized content together with English content"). Assumes the GT translation pipeline picks up the removal — please flag if that needs a manual step.wandb.init()runs each getting linked traces. The new section references the page's existing training-loop example instead of duplicating a second one. If the multi-run demonstration is worth keeping, it can be added back.verifiers.mdxlinks to the surviving page).docs.jsonvalidates as JSON.🤖 Generated with Claude Code