Skip to content

Add Academy website checks#335

Merged
glenn-jocher merged 2 commits into
mainfrom
add-academy-link-checks
Jul 13, 2026
Merged

Add Academy website checks#335
glenn-jocher merged 2 commits into
mainfrom
add-academy-link-checks

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jul 13, 2026

Copy link
Copy Markdown
Member

Summary

  • add academy.ultralytics.com to the daily website QA matrix
  • document Academy among the sites monitored for links, spelling, and image sizes

Validation

  • verified the live Academy sitemap contains 55 URLs and a course page returns HTTP 200
  • actionlint .github/workflows/links.yml
  • YAML matrix assertion with uv run python
  • uvx codespell AGENTS.md README.md
  • npx prettier --check .github/workflows/links.yml AGENTS.md README.md
  • git diff --check

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Expanded automated documentation QA to include the new Ultralytics Academy website. 🎓

📊 Key Changes

  • Added academy.ultralytics.com to the daily website link-check workflow.
  • Updated AGENTS.md to document Academy coverage in website QA.
  • Updated README.md to reflect that Academy pages are downloaded and checked for:
    • Broken links 🔗
    • Spelling issues ✍️
    • Oversized images 🖼️

🎯 Purpose & Impact

  • Ensures the Academy website receives the same automated quality checks as the other Ultralytics sites.
  • Helps detect broken links, spelling errors, and image-size problems earlier.
  • Keeps repository documentation aligned with the current website monitoring configuration.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Jul 13, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/docs 🚀 PR! 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/docs 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. This is an automated message, and an engineer will assist if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

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

Clean PR. The Academy host is correctly added to the existing matrix, so it follows the same sitemap download, link checking, spelling, and image-size validation path as the other sites. Documentation updates accurately reflect the workflow change.

@glenn-jocher
glenn-jocher merged commit 1419c3f into main Jul 13, 2026
9 of 10 checks passed
@glenn-jocher
glenn-jocher deleted the add-academy-link-checks branch July 13, 2026 16:50
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Merged—thank you, @glenn-jocher, for expanding our automated documentation QA to include the Ultralytics Academy!

“The secret of getting ahead is getting started.” — Mark Twain

By adding Academy coverage for broken links, spelling issues, and oversized images, this PR helps us get started on maintaining a more consistent, reliable learning experience for everyone. Your contribution is greatly appreciated!

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

Labels

devops GitHub Devops or MLops documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants