Skip to content

docs: SEO-consistent page titles (fix too-long + too-short <title>)#301

Merged
glenn-jocher merged 1 commit into
mainfrom
seo/handbook-titles
Jun 22, 2026
Merged

docs: SEO-consistent page titles (fix too-long + too-short <title>)#301
glenn-jocher merged 1 commit into
mainfrom
seo/handbook-titles

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

Summary

Handbook side of the cross-repo effort to fix SEMrush <title> issues consistently across every Ultralytics doc surface (docs + handbook). Strategy settled via an Opus↔Codex review loop.

Unified rule: <title> = {concise, front-loaded title} | Ultralytics (suffix added by the shared docs renderer); the on-page <h1> stays descriptive. They differ only by the suffix → never a duplicate tag; the brand is always present; titles stay in the 30–60 char range.

Changes — 4 pages with title issues (H1s unchanged)

Page H1 (kept) new title: was
security/isms.md Information Security Management System (ISMS) 🔐 Information Security (ISMS) too long (>60)
security/employee-security-compliance-requirements.md What to Expect: Security & Compliance Requirements for Employees Employee Security & Compliance too long (>60)
contributions/publications.md Publications 📚 Publications Guidelines too short (<30)
introduction.md Introduction Handbook Introduction too short (<30)

Verification

Audited all 34 handbook pages with the shared title rule (same predicate the renderer uses): 0 too-long, 0 too-short, 0 duplicate H1==title.

Companion PRs (same unified rule)

  • portal#2517 — renderer brand suffix + truncation backstop + shared title audit (merge last).
  • ultralytics#24888 — docs reference generator + narrative + short-title fixes.
  • docs#317 — compare-page H1s.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

📝 This PR improves handbook documentation metadata by adding explicit page titles to several English docs pages, making them clearer and better organized.

📊 Key Changes

  • Added a title field to the front matter of docs/en/contributions/publications.md
  • Added a title field to the front matter of docs/en/introduction.md
  • Added a title field to the front matter of docs/en/security/employee-security-compliance-requirements.md
  • Added a title field to the front matter of docs/en/security/isms.md
  • New titles introduced:
    • Publications Guidelines
    • Handbook Introduction
    • Employee Security & Compliance
    • Information Security (ISMS)

🎯 Purpose & Impact

  • 📚 Makes handbook pages easier to identify and navigate for readers
  • 🔍 Improves documentation structure and likely helps with search, SEO, and page indexing
  • 🧭 Creates more consistent metadata across the handbook, which can improve site rendering and discoverability
  • 🛠️ Low-risk documentation-only change with no effect on product code or user-facing functionality beyond clearer page labeling

Add concise front-loaded titles so every page's rendered <title> lands in the
30-60 char SEO range once the renderer appends ' | Ultralytics', while H1s stay
descriptive (distinct from <title>):
- Information Security Management System (ISMS) -> 'Information Security (ISMS)'
- What to Expect: Security & Compliance ... -> 'Employee Security & Compliance'
- Publications -> 'Publications Guidelines'
- Introduction -> 'Handbook Introduction'

Handbook now audits clean: 0 too-long, 0 too-short, 0 duplicate H1==title.
Part of the cross-repo title/H1 unification (portal renderer brand suffix,
ultralytics docs).
@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 22, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/handbook 🚀 PR! This is an automated message to help with review readiness, and an engineer will assist shortly. Please review the checklist below for 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/handbook 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

Clean PR. The changes are limited to adding explicit frontmatter titles, and the selected titles are consistent with the existing page content and the stated SEO goal. I did not find any actionable issues in the diff.

@glenn-jocher glenn-jocher merged commit f29fe26 into main Jun 22, 2026
5 checks passed
@glenn-jocher glenn-jocher deleted the seo/handbook-titles branch June 22, 2026 12:01
@UltralyticsAssistant

Copy link
Copy Markdown
Member

Merged — thank you, @glenn-jocher! 🎉

“Knowledge is of no value unless you put it into practice.” — Anton Chekhov

This update is a great example of that principle in action: small metadata improvements like clear page titles make the handbook more navigable, consistent, and useful for everyone. Adding explicit titles to these docs strengthens discoverability and helps readers find the right information faster.

Really appreciate the thoughtful polish here — concise, low-risk, and high-impact for documentation quality.

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