Skip to content

Shorten compare page titles#317

Merged
glenn-jocher merged 3 commits into
mainfrom
fix/semrush-compare-titles
Jun 22, 2026
Merged

Shorten compare page titles#317
glenn-jocher merged 3 commits into
mainfrom
fix/semrush-compare-titles

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jun 15, 2026

Copy link
Copy Markdown
Member

Summary

  • shorten compare page H1s so generated title tags stay within SEO length limits
  • replace YOLOX ReadTheDocs links with the official YOLOX GitHub docs source

Validation

  • checked 157 compare pages have title tags at or under 45 characters including | Ultralytics Docs
  • rg -n "yolox\.readthedocs\.io/en/latest/|YOLOX ReadTheDocs" docs/en/compare || true returned no matches
  • curl -I -L --max-time 30 https://github.com/Megvii-BaseDetection/YOLOX/tree/main/docs returned HTTP 200
  • git diff --check passed

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🧹 This PR standardizes and cleans up the model comparison docs by adding page titles, simplifying headings, and fixing outdated YOLOX documentation links across many comparison pages.

📊 Key Changes

  • Added explicit title fields to the frontmatter of a large number of comparison pages for better page metadata and consistency 🏷️
  • Simplified many top-level Markdown headings from long, editorial-style titles to short, uniform names like Model A vs Model B
  • Updated the comparison hub index title from a long descriptive heading to the cleaner Model Comparisons 📚
  • Replaced outdated YOLOX ReadTheDocs links with the current GitHub docs path in multiple pages 🔗
  • Applied these updates broadly across comparison docs covering DAMO-YOLO, EfficientDet, PP-YOLOE+, RTDETRv2, YOLO11, YOLO26, YOLOv5–YOLOv10, and YOLOX 🌍

🎯 Purpose & Impact

  • Improves consistency across the docs site, making comparison pages easier to scan and navigate 👀
  • Strengthens SEO and page rendering by ensuring each page has a clear, explicit title in frontmatter 🚀
  • Makes page titles cleaner for readers, browser tabs, search results, and navigation menus 🧭
  • Prevents broken or outdated external references by pointing YOLOX documentation links to an active source ✅
  • Enhances overall docs polish without changing the technical substance of the comparison content 🛠️

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request priority: low Low urgency; can wait behind higher-priority work. labels Jun 15, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/docs 🚀 PR! This is an automated message to help with review readiness—an engineer will assist shortly. Please review the checklist below to help ensure a smooth merge ✨

  • 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. Don't hesitate to leave a comment 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

The diff looks clean. The H1 simplifications are consistent with the stated naming convention, and the YOLOX link updates appear internally consistent with the surrounding content. I did not find any genuine issues in the changed lines that warrant blocking comments.

Add a consistent frontmatter title to every compare page so the rendered
<title> is uniform and SEO-strong ('... Comparison | Ultralytics'), fixing the
12 short YOLOX-pair pages that rendered <30 chars. The H1 stays the clean
'{A} vs {B}' (title now distinct from H1). All 157 compare pages audit clean:
0 too-long, 0 too-short, 0 duplicate H1==title.
@glenn-jocher glenn-jocher merged commit 8c69c94 into main Jun 22, 2026
5 checks passed
@glenn-jocher glenn-jocher deleted the fix/semrush-compare-titles branch June 22, 2026 12:01
@UltralyticsAssistant

Copy link
Copy Markdown
Member

Merged! 🎉 Thank you, @glenn-jocher, for this thoughtful docs cleanup and standardization work.

As Leonardo da Vinci said, “Simplicity is the ultimate sophistication.” This PR reflects that perfectly by making comparison pages cleaner, more consistent, easier to navigate, and more reliable with updated links and clearer titles.

These kinds of refinements make a real difference across the docs experience, and the improved coverage for YOLO11, YOLO26, YOLOv5–YOLOv10, YOLOX, and others adds lasting value for the community.

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 enhancement New feature or request priority: low Low urgency; can wait behind higher-priority work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants