Improve docs from user feedback: clarify run color settings navigation#2934
Improve docs from user feedback: clarify run color settings navigation#2934mintlify[bot] wants to merge 7 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
📚 Mintlify Preview Links📝 Changed (1 total)📄 Pages (1)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 Link Checker ResultsPreview: https://wb-21fd5541-mintlify-c7f6bef2.mintlify.site |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
📋 Validation of technical assertionsEvery claim below was checked against the truth on the ground using Glean (Slack, Jira, Confluence, GitHub) and Sourcegraph (the implementing code in 10 assertions · ✅ 6 confirmed · ✅ 2 confirmed (qualified) · 🟡 2 partial · No claim was refuted — every UI label in the new navigation matches the frontend code. Two navigation details did not fully survive: (a) reaching the Run colors controls may require selecting a Colors tab that the steps omit (#5), and (b) the Buckets section only renders after you select a Key, and is hidden entirely while run grouping is active — so a reader following the steps literally may see no Buckets section (#6; this matches a reviewer's report). Two claims are confirmed with a scope qualifier.
Open items — recommended next steps
Scope notes
🤖 Generated by the CoreWeave Docs Team's Validator ( |
| Consider the following: | ||
| 1. Navigate to your W&B project and select the **Workspace** tab. | ||
| 2. Click the **Settings** icon in the top right corner. | ||
| 3. In the drawer, select **Runs**. |
There was a problem hiding this comment.
🟡 Partially confirmed — the navigation labels here all match the app (Runs, Run colors, Key-based colors are the real UI strings). But in the frontend the Run colors controls sit under a Colors tab within the Runs settings panel: the e2e test selects the Runs menu item and then selects a separate Colors tab (getByRole('tab', {name:'Colors'})) before it can click Key-based colors. So a reader may need to select a Colors tab between step 3 (Runs) and step 4 (Run colors section).
Recommended: open a project workspace → Settings → Runs and check whether Run colors / Key-based colors shows immediately or only after selecting a Colors tab. If a click is required, add a "Select the Colors tab" step here and in the Turn on key-based colors section above (same 4-step nav). If Colors is the default tab, no change is needed.
Source: core:semantic_legends/utils.ts#L127-L131
🤖 CoreWeave Docs Team's Validator — partially confirmed
Style-only pass (Google Developer Style Guide + wandb/docs conventions)
over models/runs/color-code-runs.mdx. No UI labels, navigation steps,
code, links, anchors, frontmatter, or MDX components were changed.
Per-pass summary:
- Context/Structure: no changes; purpose, signposting, and outcomes
already present. Structural gaps flagged for review (see below)
rather than restructuring unchanged sections.
- Language: contracted "is not" to "isn't" in the Note; split a 36-word
run-on in the loss-metric example into two sentences for readability.
- Terminology: "Click on" to "Click"; directional "settings above" to
"previous settings" and "line plot below" to "following line plot".
- Considerate: no changes needed.
- Formatting: no changes needed (no em dashes or semicolons in prose).
- Polish: made the Y-value option list parallel ("Determine color based
on" to "Color based on").
- Audit: verified no remaining violations; MDX intact; broken-links clean.
Recommendations for technical review (out of scope for a style pass):
- Heading hierarchy: "Turn on key-based colors" and "Example: Key-based
coloring with loss metric" are H3 with no parent H2 (level skip).
Consider promoting to H2; anchors are unaffected.
- The "Default metrics" list follows its heading with no introductory
sentence; consider a lead-in such as "W&B defines the following
default metrics:".
- Frontmatter has no keywords field; adding 3-5 keywords was left out of
scope since frontmatter edits were excluded.
- Navigation: a separate validator flagged a possible missing "Colors"
tab step; that is a technical-content decision and was left intact.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
| 1. Navigate to your W&B project and select the **Workspace** tab. | ||
| 2. Click the **Settings** icon in the top right corner. | ||
| 3. In the drawer, select **Runs**. | ||
| 4. In the **Run colors** section, confirm that **Key-based colors** is selected. The **Buckets** section appears below the **Key** and **Y value** dropdowns. |
There was a problem hiding this comment.
🟡 Partially confirmed — the Buckets section is real, but it's conditionally rendered and these steps omit the precondition.
In the frontend, the Y value dropdown, the Number of buckets input, and the Buckets section only appear after you select a Key (the Key dropdown defaults to 'default'; the render guard is key !== DEFAULT…key). The entire key-based-colors feature is also disabled while run grouping is active ("Key-based colors are currently disabled because run grouping is active"). So a reader who opens Runs → Run colors → Key-based colors without picking a Key — or with grouping on — sees no Buckets section. (This matches a reviewer's report of not finding the section.)
Recommended: add a step to select a metric/config key from the Key dropdown before referring to the Buckets section, and note that key-based colors requires run grouping to be off. (Also note the UI has a separate "Number of buckets" stepper, distinct from the "Buckets" ranges section.)
Source: core:SemanticLegendColorTab…tsx#L97-L123, core:SemanticLegendBuckets…tsx#L103
🤖 CoreWeave Docs Team's Validator — partially confirmed
Document two preconditions that were previously implicit, surfaced by a reader who couldn't find the Buckets section: - Key-based colors are disabled while run grouping is active (add a Note in "Turn on key-based colors"). - The Y value dropdown and the Buckets section only appear after you select a Key (split the "Customize buckets" step so selecting a key is explicit). Verified against wandb/core (SemanticLegendColorTabWithCategoricalConfig render guards and the run-grouping disable banner). mint broken-links: pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The Customize buckets steps assumed a metric key and a fixed layout. A reader with grouping off still could not find the Buckets section because the metric vs. configuration key paths differ: - Selecting Key-based colors hides Color palette and reveals the Key dropdown; the remaining controls appear only after a key is selected. - Metric key: Y value (Min/Max/Latest) + Number of buckets + Buckets section. - Configuration key: a Grouping dropdown (Continuous/Discrete); Discrete shows a Categories section instead of Buckets. Verified against wandb/core (SemanticLegendColorTab, SemanticLegendYValue, SemanticLegendBuckets). mint broken-links: pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 participant
Summary
Add explicit navigation context to the screenshots on the semantic run plot legends page so readers can locate the settings shown.
Changes
Feedback basis
Contextual feedback on
/models/runs/color-code-runsreported that it was unclear where the screenshots come from or how to reach the pictured UI. The screenshots for the buckets section in particular lacked navigation steps, unlike the "Turn on key-based colors" section higher on the page.