Skip to content

Conversation

@raimbekovm
Copy link

@raimbekovm raimbekovm commented Jan 24, 2026

Add images for the Modal quickstart guide documentation:

  • modal-terminal-output.png - Terminal output showing YOLO26 inference results
  • modal-dashboard-function-calls.png - Modal dashboard showing successful function execution

Related to ultralytics/ultralytics#23414

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Adds new Modal quickstart guide images to the ultralytics/assets docs set 🖼️

📊 Key Changes

  • Added/updated documentation image assets:
  • docs/modal-dashboard-function-calls.png
  • docs/modal-terminal-output.png

🎯 Purpose & Impact

  • Improves clarity of the Modal quickstart documentation by providing visual references 📚
  • Helps users follow along faster with real UI/terminal examples, reducing confusion and setup friction ⚡
📋 Skipped 2 files (lock files, generated, images, etc.)
  • docs/modal-dashboard-function-calls.png
  • docs/modal-terminal-output.png

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Jan 24, 2026
@UltralyticsAssistant
Copy link
Member

👋 Hello @raimbekovm, thank you for submitting a ultralytics/assets 🚀 PR! This is an automated message, and an Ultralytics engineer will assist shortly. To ensure a seamless integration of your work, please review the following checklist:

-✅ Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
-✅ Synchronize with Source: Confirm your PR is synchronized with the ultralytics/assets main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
-✅ Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
-✅ Update Documentation: Update the relevant documentation for any new or modified features.
-✅ Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
-✅ Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
-✅ Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

Copy link
Member

@UltralyticsAssistant UltralyticsAssistant left a comment

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

All 2 changed files are generated/vendored (skipped review)

📋 Skipped 2 files (lock files, generated, images, etc.)
  • docs/modal-dashboard-function-calls.png
  • docs/modal-terminal-output.png

@pderrenger
Copy link
Member

Thanks for adding these Modal quickstart screenshots—please double-check they’re compressed to a reasonable size and don’t include any sensitive info; once CI is green we can proceed with review/merge (see the Documentation Workflow for our image/media guidelines).

@raimbekovm
Copy link
Author

Thanks for the review! I've made the following changes:

  • Removed modal-terminal-output.avif - replaced with text output in the documentation
  • Kept modal-dashboard-function-calls.avif (27KB) - shows only public function call info

The remaining screenshot is compressed and doesn't contain any sensitive information.

@pderrenger
Copy link
Member

Sounds good—please just make sure the Modal quickstart is referencing the new docs/modal-dashboard-function-calls filename/extension (so we don’t leave any broken image links after removing the terminal screenshot), and once CI is green I’ll take a final look and we can merge.

@raimbekovm
Copy link
Author

The Modal quickstart PR (ultralytics/ultralytics#23414) references the correct path: docs/modal-dashboard-function-calls.avif. CI is green, ready to merge!

@pderrenger
Copy link
Member

Thanks for confirming—I'll do a final quick check on the .avif and merge this assets PR; once it’s merged, please re-run CI on the docs PR to ensure the image resolves correctly.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants