Skip to content

docs: clarify update-artifact wording (DOCS-1215)#2329

Open
johndmulhausen wants to merge 8 commits intomainfrom
better-phrasing
Open

docs: clarify update-artifact wording (DOCS-1215)#2329
johndmulhausen wants to merge 8 commits intomainfrom
better-phrasing

Conversation

@johndmulhausen
Copy link
Copy Markdown
Contributor

Summary

Updates Update an artifact to avoid vague "inside/outside a run" language. The page now contrasts while a run is active with Public API only (no wandb.init()), renames the second tab accordingly, and tightens the intro and guidance paragraphs.

Test plan

  • mint broken-links (optional)
  • Spot-check the page in Mintlify preview

Resolves DOCS-1215

Made with Cursor

Replace inside/outside run phrasing with while a run is active, Public API only, and wandb.init() guidance.

Resolves DOCS-1215

Made-with: Cursor
@johndmulhausen johndmulhausen requested a review from a team as a code owner March 20, 2026 18:36
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 20, 2026

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

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Mar 20, 2026, 6:39 PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 20, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
models/artifacts/update-an-artifact.mdx Update An Artifact

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 4a905c5 at 2026-03-23 18:34:02 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 20, 2026

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-better-phrasing.mintlify.app

Copy link
Copy Markdown
Contributor

@ngrayluna ngrayluna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's more work to be done here. I am going to checkout the branch and push changes.

johndmulhausen and others added 2 commits March 23, 2026 12:32
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
johndmulhausen and others added 3 commits March 23, 2026 12:33
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
@ngrayluna
Copy link
Copy Markdown
Contributor

Pushed changes. Methinks it looks good? cc @johndmulhausen

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants