Skip to content

docs(weave): consolidate trace-to-run page into weave-in-workspaces - #3032

Draft
dbrian57 wants to merge 1 commit into
mainfrom
dbrian57/docs-consolidate-trace-to-run
Draft

docs(weave): consolidate trace-to-run page into weave-in-workspaces#3032
dbrian57 wants to merge 1 commit into
mainfrom
dbrian57/docs-consolidate-trace-to-run

Conversation

@dbrian57

@dbrian57 dbrian57 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

What changed

Consolidates two Weave docs pages that documented the same Weave trace ↔ W&B run integration:

  • Removed: weave/guides/tracking/trace-to-run.mdx ("Link a W&B run to trace function calls", ~400 words)
  • Extended: 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"
  • Redirect: /weave/guides/tracking/trace-to-run/weave/guides/tools/weave-in-workspaces (same pattern as the earlier trace-agent-integrations merge)
  • Nav: removed the English docs.json entry; carried the trace-linking keywords (wandb.init, trace linking, experiment tracking) into the merged page's frontmatter

Why

  • Both pages explained the same automatic trace-to-run linking behavior with near-identical code patterns (weave.init() + @weave.op + wandb.init() + run.log()), which invites drift.
  • The smaller page was a near-subset of the larger one — its only unique content was how to see the linked run in the Weave Traces table.
  • Neither page linked to the other, so readers of one never discovered set_wandb_run_context() or the Traces-table view, respectively.
  • The two pages sat directly adjacent in the same nav group.

Reviewer notes

  • Localization: fr/, ja/, and ko/ 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.
  • Dropped example: the removed page's example showed two separate 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.
  • Page title: kept "Use Weave with W&B training runs" even though the merged content isn't strictly training-specific; retitling was left out of scope to avoid extra churn.
  • No other English pages linked to the removed URL (only verifiers.mdx links to the surviving page). docs.json validates as JSON.

🤖 Generated with Claude Code

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>
@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Aug 6, 2026, 3:02 PM

@dbrian57 dbrian57 added the author-docs-plugin Docs PRs authored via Cursor author-docs skill label Aug 6, 2026
@dbrian57

dbrian57 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

Sources and decision log

Sources. 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:

  • Automatic trace-to-run linking behavior and Traces-table viewing steps: from weave/guides/tracking/trace-to-run.mdx (removed page, last touched in style: apply /style-guide pass to weave #2739's style pass)
  • Training-loop example, set_wandb_run_context()/clear_wandb_run_context(), artifact references: pre-existing content of weave/guides/tools/weave-in-workspaces.mdx, unchanged
  • Redirect pattern: existing docs.json redirect for /weave/guides/tracking/trace-agent-integrations (a prior page merge)
  • Localization handling: AGENTS.md ("avoid editing localized content together with English content")

Decisions.

  • New section placed before "Associate traces with a specific W&B run" so the default auto-link behavior is introduced before its override.
  • Kept one canonical code example (the training loop) rather than duplicating the removed page's two-run example; the new section's steps reference it.
  • Kept the removed page's "not available in the TypeScript SDK" caveat as a <Note>.
  • Left fr//ja//ko files and nav entries for the translation pipeline.

Needs SME verification

  • "Linking traces to W&B runs is not yet available in the TypeScript SDK" — carried over verbatim from the removed page; not independently re-verified against the current TypeScript SDK.
  • Confirm the GT translation pipeline removes the orphaned fr//ja//ko copies of trace-to-run (or whether that needs a manual follow-up).
  • Whether the two-run demonstration from the removed page (traces linking to two separate wandb.init() runs) is worth re-adding as a second example.

@dbrian57

dbrian57 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

Resume prompt

Continue work on #3032 (branch dbrian57/docs-consolidate-trace-to-run off main in wandb/docs). The PR merges weave/guides/tracking/trace-to-run.mdx into weave/guides/tools/weave-in-workspaces.mdx: a new "View a linked run in the Traces table" section was added between "Use Weave panels" and "Associate traces with a specific W&B run", the old English page and its docs.json nav entry were removed, and a redirect /weave/guides/tracking/trace-to-run/weave/guides/tools/weave-in-workspaces was added. Key decisions: single canonical code example (the training loop), TypeScript-unsupported caveat kept as a Note, fr/ja/ko copies intentionally untouched for the translation pipeline, page title left as "Use Weave with W&B training runs". Open items are in the "Needs SME verification" checklist in the sources comment. No JIRA ticket is associated.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Readability impact

Word-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

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
weave/guides/tools/weave-in-workspaces.mdx 9.9 9.5 -0.4 +1.2 easier
weave/guides/tracking/trace-to-run.mdx page removed

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
weave/guides/tools/weave-in-workspaces.mdx 2 2 +0

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 31113585799

@dbrian57

dbrian57 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author
{
  "skill": "author-docs",
  "version": "1.0.0",
  "depends_on": { "style-guide": "1.0.0" },
  "skills_invoked": [],
  "model": "claude-fable-5"
}

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (2 total)

📄 Pages (1)

File Preview
weave/guides/tools/weave-in-workspaces.mdx Weave In Workspaces
⚙️ Other (1)
File
docs.json

🗑️ Deleted (1 total)

View deleted files

📄 Pages (1)

File
weave/guides/tracking/trace-to-run.mdx

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 721cefd at 2026-08-06 15:03:17 UTC

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-dbrian57-docs-consolidate-trace-to-run.mintlify.site/weave/guides/tools/weave-in-workspaces

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