Skip to content

Add W&B mobile app documentation#2234

Open
johndmulhausen wants to merge 27 commits intomainfrom
mobile-app
Open

Add W&B mobile app documentation#2234
johndmulhausen wants to merge 27 commits intomainfrom
mobile-app

Conversation

@johndmulhausen
Copy link
Contributor

@johndmulhausen johndmulhausen commented Mar 5, 2026

Summary

Adds documentation for the new Weights & Biases mobile app.

Changes

  • New page: Weights & Biases mobile app under Platform → Monitoring and usage
  • Content: Describes the mobile app for monitoring training runs and exploring project histories from iPhone/iPad
  • Screenshots: 4 app screenshots in a 4x1 grid layout
  • Navigation: Added 'New' badge to the sidebar for the mobile app page
  • Banner: Site-wide Mintlify banner announcing the mobile app with link to the docs
  • App Store: Card with placeholder URL (to be updated when ready)

Screenshots

The page includes 4 mobile app screenshots from /images/mobile-app/.

Made with Cursor

Resolves DOCS-1928

- Add mobile app documentation page under Monitoring and usage
- Include 4 screenshots in 4x1 grid layout
- Add 'New' badge to sidebar navigation
- Add site-wide banner announcing the mobile app
- Link to App Store (placeholder URL)

Made-with: Cursor
@johndmulhausen johndmulhausen requested a review from a team as a code owner March 5, 2026 19:30
@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

Images automagically compressed by Calibre's image-actions

Compression reduced images by 82.1%, saving 933.4 KB.

Filename Before After Improvement Visual comparison
images/mobile-app/mobile-app-3.png 326.6 KB 60.4 KB 81.5% View diff
images/mobile-app/mobile-app-1.png 287.2 KB 43.4 KB 84.9% View diff
images/mobile-app/mobile-app-2.png 299.9 KB 57.7 KB 80.8% View diff
images/mobile-app/mobile-app-4.png 223.0 KB 41.9 KB 81.2% View diff

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (5 total)

📄 Pages (1)

File Preview
platform/hosting/monitoring-usage/mobile-app.mdx Mobile App

🖼️ Images (4)

File Preview
images/mobile-app/manage-alerts.png View Manage Alerts
images/mobile-app/project-panels.png View Project Panels
images/mobile-app/project-runs.png View Project Runs
images/mobile-app/projects.png View Projects

📝 Changed (1 total)

⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 920017c at 2026-03-13 21:23:18 UTC

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

🔗 Link Checker Results

⚠️ Some issues were detected

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


Summary

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

Errors per input

Errors in platform/hosting/monitoring-usage/mobile-app.mdx

Full Github Actions output

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

Images automagically compressed by Calibre's image-actions

Compression reduced images by 7%, saving 11.4 KB.

Filename Before After Improvement Visual comparison
images/mobile-app/mobile-app-3.png 60.4 KB 56.0 KB 7.1% View diff
images/mobile-app/mobile-app-1.png 43.4 KB 39.8 KB 8.4% View diff
images/mobile-app/mobile-app-2.png 57.7 KB 54.3 KB 5.9% View diff

1 image did not require optimisation.

- Add Requirements section at top with iOS requirement (Android users see it first)
- Use 'W&B' consistently instead of 'Weights & Biases' to match W&B App naming
- Switch to Mintlify Columns component for screenshot grid
- Rename images with descriptive names for maintenance (runs-list, run-detail, projects, workspace)
- Improve alt text for accessibility
- Remove redundant Info callout (moved to Requirements)

Made-with: Cursor
@johndmulhausen
Copy link
Contributor Author

Addressed PR feedback from @mdlinville:

  • Requirements section – Added at top so Android users see the iOS-only note right away
  • W&B naming – Using 'W&B' consistently throughout to match W&B App
  • Columns component – Switched from custom div to Mintlify Columns for the screenshot grid
  • Image naming – Renamed to descriptive names (runs-list, run-detail, projects, workspace) with improved alt text
  • Periods – Added to Features list items per suggestion
  • 📝 Image cropping – Can't crop programmatically; could be done in a follow-up if desired
  • 📝 Image placement – Kept at top as overview; could move to illustrate each feature if preferred

@mdlinville
Copy link
Contributor

🔗 Link Checker Results

⚠️ Some issues were detected

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

Summary

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

Errors per input

Errors in platform/hosting/monitoring-usage/mobile-app.mdx

Full Github Actions output

Expected while it's not on the app store, maybe comment out the link for now with a TODO.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

Images automagically compressed by Calibre's image-actions

Compression reduced images by 5.9%, saving 3.3 KB.

Filename Before After Improvement Visual comparison
images/mobile-app/mobile-app-projects.png 56.0 KB 52.8 KB 5.9% View diff

3 images did not require optimisation.

Copy link
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

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

LGTM!

@johndmulhausen johndmulhausen marked this pull request as ready for review March 10, 2026 21:11
Copy link
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

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

Just a couple of minor trailing suggestions about headings, but this looks great to me.

@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 8.7%, saving 16.5 KB.

Filename Before After Improvement Visual comparison
images/mobile-app/project-panels.png 101.1 KB 94.0 KB 7.1% View diff
images/mobile-app/project-runs.png 52.6 KB 46.6 KB 11.5% View diff
images/mobile-app/manage-alerts.png 36.7 KB 33.5 KB 8.9% View diff

1 image did not require optimisation.

Co-authored-by: Matt Linville <matt.linville@wandb.com>
@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 6.8%, saving 8.6 KB.

Filename Before After Improvement Visual comparison
images/mobile-app/project-panels.png 94.0 KB 89.0 KB 5.3% View diff
images/mobile-app/manage-alerts.png 33.5 KB 29.8 KB 10.8% View diff

2 images did not require optimisation.

…, Weave integration, and additional chart types.
…ll icon and enhancing the description of upcoming features.
…roduction and removing the mention of upcoming Android support.
@tristan-spaulding2
Copy link
Contributor

tristan-spaulding2 commented Mar 12, 2026

@johndmulhausen I woould suggest noting this is only available for W&B SaaS accounts and not dedicated or customer managed. Would also suggest taking out the coming soon parts as neither of those points is necessarily true

…de line plots and specifying W&B Models projects for iOS. Adjust feature descriptions for clarity.
@johndmulhausen
Copy link
Contributor Author

I woould suggest noting this is only available for W&B SaaS accounts and not dedicated or customer managed.

Cool, done!

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.

3 participants