Skip to content

[DOCS-1989] Release notes and updated CLI refs for SDK 0.24.0 #2042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
mdlinville wants to merge 7 commits into
base: main
Choose a base branch
from
Open

[DOCS-1989] Release notes and updated CLI refs for SDK 0.24.0 #2042

mdlinville wants to merge 7 commits into from
+48 −5

Conversation

@mdlinville
Copy link
Contributor

@mdlinville mdlinville commented Jan 15, 2026 •
edited
Loading

Description

DOCS-1989 Release notes and updated CLI refs for SDK 0.24.0

To regenerate the references, I upgraded the wandb module to 0.24.0, then ran python3 scripts/cli-docs-generator.py.

This PR contains 3 commits:

  1. A fix to a bug I noticed where the argument table would be broken up if argument descriptions had newlines.
  2. Regenerated the references with the fix in place to validate it.
  3. SDK 0.24.0 release notes, copied from wandb/wandb with the committer and PR details removed.

Testing

  • Local build succeeds without errors (mint dev)
  • Local link check succeeds without errors (mint broken-links)
  • PR tests succeed

@mdlinville mdlinville marked this pull request as ready for review January 15, 2026 00:34
@mdlinville mdlinville requested a review from a team as a code owner January 15, 2026 00:34
mdlinville
mdlinville commented Jan 15, 2026
View reviewed changes
@github-actions
Copy link
Contributor

github-actions bot commented Jan 15, 2026 •
edited
Loading

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (4 total)

📄 Pages (4)

File Preview
models/ref/cli.mdx Cli
models/ref/cli/wandb-agent.mdx Wandb Agent
models/ref/cli/wandb-beta/wandb-beta-sync.mdx Wandb Beta Sync
release-notes/sdk-releases.mdx Sdk Releases

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 9fed187 at 2026-01-16 21:58:40 UTC

@mdlinville mdlinville enabled auto-merge (squash) January 16, 2026 16:34
@github-actions
Copy link
Contributor

github-actions bot commented Jan 16, 2026 •
edited
Loading

🔗 Link Checker Results

Note

Links to newly created files in this PR may be reported as broken because this checks links against the preview deployment.

Warnings about new files in this PR can be safely ignored.

Tip

Redirects detected: If you see redirects for internal docs.wandb.ai links, check if they have trailing slashes.

Mintlify automatically removes trailing slashes, causing redirects like:

  • https://docs.wandb.ai/models/ → https://docs.wandb.ai/models
  • /weave/quickstart/ → /weave/quickstart

Fix: Remove trailing slashes from links to avoid unnecessary redirects.

Summary

Status Count
🔍 Total 253
✅ Successful 218
⏳ Timeouts 0
🔀 Redirected 1
👻 Excluded 0
❓ Unknown 0
🚫 Errors 34
⛔ Unsupported 0

Errors per input

Errors in release-notes/sdk-releases.mdx

Redirects per input

Redirects in release-notes/sdk-releases.mdx

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mdlinville