Skip to content

CLI docs OKR#2247

Open
ngrayluna wants to merge 19 commits intomainfrom
cli_docs_okr
Open

CLI docs OKR#2247
ngrayluna wants to merge 19 commits intomainfrom
cli_docs_okr

Conversation

@ngrayluna
Copy link
Copy Markdown
Contributor

@ngrayluna ngrayluna commented Mar 6, 2026

Description

Doc preview for CLI docstring changes proposed here: wandb/wandb#11322

Do not merge. This can be merged after source code descriptions are approved AND the docs are regenerated using the latest SDK Release tag.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 6, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (5 total)

📄 Pages (5)

File Preview
models/ref/cli/wandb-beta/wandb-beta-core.mdx Wandb Beta Core
models/ref/cli/wandb-beta/wandb-beta-core/wandb-beta-core-start.mdx Wandb Beta Core Start
models/ref/cli/wandb-beta/wandb-beta-core/wandb-beta-core-stop.mdx Wandb Beta Core Stop
models/ref/cli/wandb-beta/wandb-beta-leet/wandb-beta-leet-symon.mdx Wandb Beta Leet Symon
models/ref/cli/wandb-purge-cache.mdx Wandb Purge Cache

📝 Changed (40 total)

📄 Pages (39)

File Preview
models/ref/cli.mdx Cli
models/ref/cli/wandb-agent.mdx Wandb Agent
models/ref/cli/wandb-artifact.mdx Wandb Artifact
models/ref/cli/wandb-artifact/wandb-artifact-cache.mdx Wandb Artifact Cache
models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup.mdx Wandb Artifact Cache Cleanup
models/ref/cli/wandb-artifact/wandb-artifact-get.mdx Wandb Artifact Get
models/ref/cli/wandb-artifact/wandb-artifact-ls.mdx Wandb Artifact Ls
models/ref/cli/wandb-artifact/wandb-artifact-put.mdx Wandb Artifact Put
models/ref/cli/wandb-beta.mdx Wandb Beta
models/ref/cli/wandb-beta/wandb-beta-leet.mdx Wandb Beta Leet
... and 29 more files
⚙️ Other (1)
File
docs.json

🗑️ Deleted (9 total)

View deleted files

📄 Pages (9)

File
models/ref/cli/wandb-local.mdx
models/ref/cli/wandb-off.mdx
models/ref/cli/wandb-on.mdx
models/ref/cli/wandb-projects.mdx
snippets/en/_includes/cli/wandb-docker-run.mdx
snippets/en/_includes/cli/wandb-docker.mdx
snippets/en/_includes/cli/wandb-login.mdx
snippets/en/_includes/cli/wandb-sync.mdx
snippets/en/_includes/cli/wandb-verify.mdx

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 46249e9 at 2026-03-31 03:56:35 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 6, 2026

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-cli-docs-okr.mintlify.app


```bash
wandb agent SWEEP_ID [OPTIONS]
Usage: agent [OPTIONS] SWEEP_ID
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I got curious how this looks, and noticed that the usage doesn't give context for where you'd put Arguments vs Options, but I wasn't sure if that would actually cause any confusion.

@ngrayluna ngrayluna added the DO-NOT-MERGE For PRs that should not be merged yet label Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO-NOT-MERGE For PRs that should not be merged yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants