Shorten compare page titles#317
Conversation
|
👋 Hello @glenn-jocher, thank you for submitting a
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
left a comment
There was a problem hiding this comment.
🔍 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.
|
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. |
Summary
Validation
| Ultralytics Docsrg -n "yolox\.readthedocs\.io/en/latest/|YOLOX ReadTheDocs" docs/en/compare || truereturned no matchescurl -I -L --max-time 30 https://github.com/Megvii-BaseDetection/YOLOX/tree/main/docsreturned HTTP 200git diff --checkpassed🛠️ 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
titlefields to the frontmatter of a large number of comparison pages for better page metadata and consistency 🏷️Model A vs Model B✨Model Comparisons📚🎯 Purpose & Impact