Skip to content

Tighten live-site spellcheck false positives#321

Merged
glenn-jocher merged 1 commit into
mainfrom
fix-live-site-qa-allowlists
Jun 27, 2026
Merged

Tighten live-site spellcheck false positives#321
glenn-jocher merged 1 commit into
mainfrom
fix-live-site-qa-allowlists

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🧹 This PR improves the docs link-checking workflow by making spellcheck more reliable and reducing false positives from generated HTML content.

📊 Key Changes

  • Added a preprocessing step in .github/workflows/links.yml to replace curly apostrophes with standard apostrophes before running codespell.
  • Kept existing cleanup of embedded <script>, <style>, and avatar fallback HTML, while extending it to better normalize page text for spellchecking.
  • Expanded the codespell ignore list with additional valid words and proper names, including Vektor, MITRE, and Confidencial.

🎯 Purpose & Impact

  • ✅ Reduces unnecessary spellcheck failures caused by formatting differences in rendered HTML, especially smart quotes.
  • 🔍 Helps CI focus on real spelling issues instead of flagging valid names or content-specific terms.
  • 🚀 Makes documentation checks more stable and maintainable, which can speed up PR reviews and reduce noise for contributors.
  • 🛠️ Improves the overall reliability of automated quality checks in the ultralytics/docs repository.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation priority: low Low urgency; can wait behind higher-priority work. labels Jun 27, 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 you shortly 😊 Please review the checklist below to help ensure a smooth integration:

  • 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

Good cleanup overall, but there are two correctness issues to address before this achieves its goal: the new docs exclusion regex is malformed in both workflows, and the expanded global codespell allowlist now suppresses at least one clear typo that should still be caught.

💬 Posted 3 inline comments

Comment thread .github/workflows/links.yml Outdated
Comment thread .github/workflows/links_local.yml Outdated
Comment thread .github/workflows/links.yml Outdated
@glenn-jocher glenn-jocher force-pushed the fix-live-site-qa-allowlists branch from d9380da to d7a89e5 Compare June 27, 2026 20:34
@glenn-jocher glenn-jocher changed the title Update live-site QA allowlists Tighten live-site spellcheck false positives Jun 27, 2026
@glenn-jocher

Copy link
Copy Markdown
Member Author

Resolved the stale review findings in commit d7a89e5. This PR no longer suppresses source bugs like Platorm, platformdeploy, platformtrain/cloud-training, tasksdetect, or British spelling variants. Those were fixed directly in the www CMS instead; a CMS scan now returns zero matches for those old strings. The remaining codespell additions are only true false positives: Vektor, MITRE, Confidencial, and .alls.

@glenn-jocher glenn-jocher force-pushed the fix-live-site-qa-allowlists branch from d7a89e5 to 43f5073 Compare June 27, 2026 20:46
@glenn-jocher

Copy link
Copy Markdown
Member Author

Follow-up: removed alls from the codespell ignore list as well. The Hailo docs source should keep the real .alls extension in prose, and the source fix is to avoid bare alls identifiers rather than hide the word globally.

@glenn-jocher glenn-jocher merged commit e9b2ceb into main Jun 27, 2026
5 checks passed
@glenn-jocher glenn-jocher deleted the fix-live-site-qa-allowlists branch June 27, 2026 20:52
@UltralyticsAssistant

Copy link
Copy Markdown
Member

Merged! 🎉 Thanks, @glenn-jocher, for tightening up the docs link-checking workflow and making spellcheck far more reliable.

As Benjamin Franklin said, “An ounce of prevention is worth a pound of cure.” This update is a perfect example of that: reducing false positives, normalizing generated HTML text, and expanding valid ignores helps CI focus on real issues instead of noise.

Really appreciate the thoughtful polish here — improvements like this make reviews smoother and the ultralytics/docs repo more maintainable for everyone.

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 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