style: apply /style-guide pass to models/reports

[johndmulhausen]

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to the Reports section under models/reports. The run was automated; no technical content was intentionally changed.

Files edited

• models/reports/clone-and-export-reports.mdx
• models/reports/collaborate-on-reports.mdx
• models/reports/create-a-report.mdx
• models/reports/cross-project-reports.mdx
• models/reports/edit-a-report.mdx
• models/reports/embed-reports.mdx
• models/reports/reports-gallery.mdx

Recommendations for technical review

Prerequisites

• Report and Workspace API examples reference wr without showing or linking the import (e.g., import wandb_workspaces.reports.v2 as wr) — confirm whether to add or link this prerequisite (clone-and-export-reports.mdx).
• PROJECT and ENTITY placeholders are introduced inline; consider linking to the entities/projects concept pages, and note CoreWeave convention prefers [ALL-CAPS-HYPHENATED] placeholders — converting requires touching code samples (clone-and-export-reports.mdx).
• create-a-report.mdx (API tab) has no prerequisites section; consider whether to require an authenticated W&B environment, a supported Python version, or a wandb login step.
• collaborate-on-reports.mdx lists no prerequisites (team/project/org membership, role or permission level required to share, edit, comment, or star) — consider adding one.
• embed-reports.mdx lacks a brief prerequisites section (e.g., a published report URL or specific sharing permissions).
• cross-project-reports.mdx does not define "run set" or link to run set documentation, references "private/team/public/open project" without linking project-visibility docs, and uses "magic link" and "view-only link" interchangeably without defining them together.

Verification steps

• Neither flow in clone-and-export-reports.mdx (UI export, UI clone, API clone) has a "you should see..." statement after the procedure.
• collaborate-on-reports.mdx: after Save to report, the doc does not describe how a reader confirms changes were saved (status indicator, draft location if not published); and after Invite or sharing link, no way to verify the recipient has access or to revoke it.
• create-a-report.mdx (Report tab) ends at "Click Create report" without describing the resulting screen; the W&B App tab step 4 outcome ("A draft report is saved automatically") could cross-link to the publish/edit workflow.
• cross-project-reports.mdx: no way to confirm a cross-project pull worked (e.g., expected run set table state), and no way to confirm a view-only link works or to revoke/rotate the secret token.
• edit-a-report.mdx: Visualize relationships across multiple dimensions ends without a screenshot, sample output, or rendered example.
• embed-reports.mdx: the HTML iframe procedure does not describe what the embedded report should look like once pasted.

Technical accuracy

• clone-and-export-reports.mdx: confirm the action menu > Download > PDF/LaTeX click path is current; confirm wr.Report.from_url(report.url) is still the recommended clone-via-API workflow; the top-level <Note> about Public Preview applies only to the API tab and may need to be scoped.
• collaborate-on-reports.mdx: the "edit conflict" warning is mentioned but the resolution UI and user options aren't described; confirm the Invite and Share button labels still match the current UI; consider whether full-screen panel URL-sharing belongs under "Share a report" or in a panels/embedding section.
• create-a-report.mdx: confirm whether Report should be styled as a class name (Report class) or remain prose (line 53); confirm "select the Filter run sets option" sufficiently conveys reversibility after the redundant toggle phrasing was removed.
• cross-project-reports.mdx: the statement that history data on time series lines is supported but summary metrics across projects aren't could use a concrete example or workaround link; the "add a tag and move runs" workaround has no link to instructions for moving runs between projects.
• edit-a-report.mdx: step 2 in Visualize relationships across multiple dimensions ("Highlight key trends. Hover over a specific group of runs to highlight them in the visualization") reads more like a tip than a sequential step; the audit pass changed `run sets` to `runsets` (line 99) to match the runsets= parameter — confirm; the audit pass unified the Tabs title to App UI across all Tabs sections (previously two used "W&B App") — confirm which label is canonical.
• embed-reports.mdx: verify only fully public reports embed correctly versus reports shared via magic links or team visibility (line 16); reconcile Confluence guidance — prose says "insert the direct link... within an iframe cell," but the HTML section instructs copying a full <iframe> embed code (line 25); verify Confluence has a built-in iframe macro versus requiring an add-on (line 25); confirm Notion's Embed block accepts the full embed code, not just a report URL (line 33); verify the Gradio f-string <iframe> (no closing tag) renders correctly in gr.HTML (line 48); confirm the Share button is still in the upper right of a report (line 13).
• reports-gallery.mdx: verify external link liveness — all example report links point to public wandb.ai/stacey/... URLs plus a bit.ly/wandb-learning-dexterity shortlink, which can rot.

Missing content

• clone-and-export-reports.mdx: no troubleshooting guidance for failed exports or clones (e.g., team permissions when cloning).
• collaborate-on-reports.mdx: no coverage of how to stop sharing, remove a collaborator, or change permissions; who can see comments, whether comments support mentions/notifications, or how to resolve/delete them; whether starred reports are visible only to the current user or to the team (the closing sentence implies the latter); and no links to related concepts (Reports overview, project/team permissions, panels).
• create-a-report.mdx (API tab): no wandb.login() or authentication step is shown before report.save() — confirm whether intentional.
• cross-project-reports.mdx: no procedure for generating or toggling a view-only link in the UI (only what view-only mode is); no mention of where in the UI to find the project selector beyond "in the run set table"; no guidance on choosing a destination report for Add to report (new vs. existing).
• edit-a-report.mdx: introduction lists no prerequisites beyond the pip install Note; the Group runs by config values code example (lines 250–264) has uneven indentation in the report.blocks literal.
• embed-reports.mdx: the Gradio example URL is hardcoded to _scott/pytorch-sweeps-demo/... (an individual user's report) — consider a placeholder or a canonical W&B-owned sample.
• reports-gallery.mdx: intro doesn't explicitly name the audience (first-time authors vs. experienced users looking for templates); the Notes section bundles two distinct example patterns under one H2 — consider splitting; all three H2 headings use a Label: action colon pattern unusual for the style guide — consider refactoring as H2 label + H3 subtitle or dropping the labels.

How to review

• Each file's changes are style edits only. Compare side-by-side and flag any that change technical meaning.
• Approve and merge to accept the edits, or close to reject them.

[mintlify]

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

Project	Status	Preview	Updated (UTC)
wandb	🟢 Ready	View Preview	Jun 4, 2026, 3:38 PM

[github-actions]

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-models-reports-20260604-112843.mintlify.app

[github-actions]

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (7 total)

📄 Pages (7)

File	Preview
models/reports/clone-and-export-reports.mdx	Clone And Export Reports
models/reports/collaborate-on-reports.mdx	Collaborate On Reports
models/reports/create-a-report.mdx	Create A Report
models/reports/cross-project-reports.mdx	Cross Project Reports
models/reports/edit-a-report.mdx	Edit A Report
models/reports/embed-reports.mdx	Embed Reports
models/reports/reports-gallery.mdx	Reports Gallery

---

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: ed935bd at 2026-06-10 17:10:00 UTC

[Copilot]

Pull request overview

This PR applies an automated style-guide pass to the Reports documentation under models/reports, aiming to improve consistency and readability without intentionally changing technical meaning.

Changes:

• Updates frontmatter keywords and refines wording across multiple Reports docs pages.
• Clarifies/expands several procedural descriptions (sharing, embedding, cross-project reporting, cloning/exporting).
• Normalizes some headings, UI terminology, and explanatory phrasing.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
models/reports/clone-and-export-reports.mdx	Minor wording/alt-text updates and adds a post-save outcome sentence for the API cloning flow.
models/reports/collaborate-on-reports.mdx	Restructures intro/share/edit/comment/star sections and reorders the sharing GIF placement.
models/reports/create-a-report.mdx	Rewrites the intro, tweaks steps/alt text, and lightly refines API instructions.
models/reports/cross-project-reports.mdx	Expands the introduction and refines view-only link explanations and “send to report” wording.
models/reports/edit-a-report.mdx	Broad set of style edits across many sections (terminology, steps, class-name casing in prose).
models/reports/embed-reports.mdx	Refines the embed instructions and strengthens Confluence/Notion explanatory text.
models/reports/reports-gallery.mdx	Updates keywords, expands the intro sentence, and refines headings and link lead-ins.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.