Skip to content

Fix website glossary spellcheck false positives - #369

Merged
glenn-jocher merged 2 commits into
mainfrom
website-spellcheck-link-false-positives
Oct 12, 2026
Merged

glenn-jocher merged 2 commits into
mainfrom
website-spellcheck-link-false-positives

Conversation

@nastijakh

@nastijakh nastijakh commented Oct 12, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes the 21 spelling false positives in the scheduled Website links and spellcheck run.

Adds 11 verified terms to the existing rendered-HTML codespell ignore list: fpr, dialogue, dialogues, SME, redner, sEH, Mata, IST, DifferNet, Sclar, and Centre. These are code identifiers, technical names, proper nouns, or accepted US English spellings. The change is one line in the existing spelling owner.

The two link failures were repaired directly in the published CMS records through the Portal API, with before/after backups:

No new domain exclusions remain; Uber and MIT links stay covered by the checker.

Validation: codespell 2.4.3 with the workflow's exact options reproduced all 21 errors across 18 live pages on the base configuration, then reported zero with this change. Control misspellings remained detectable. Both replacement URLs passed lychee without exclusions, and both public glossary pages now render the new links with the old links absent. Both workflow files parse as YAML, Prettier passes, and all three existing link-check exclusion patterns remain identical and unchanged from main.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updated the website spellcheck ignore list and repaired two glossary links to resolve the scheduled checker’s reported issues.

📊 Key Changes

  • Added 11 verified terms to the rendered-HTML codespell ignore list.
  • Updated the Feature Store link to Uber’s working Michelangelo article URL.
  • Updated the Spatial Computing link to the thesis’s current MIT publication URL; both links remain checked without new domain exclusions.

🎯 Purpose & Impact

  • The glossary pages now point to the replacement URLs, and the added terms no longer trigger the reported spellcheck false positives.

…ce.mit.edu, glossary terms)

Ignore proper nouns, a code variable, and US-standard "dialogue" flagged on www glossary pages; exclude bot-protected uber.com and dspace.mit.edu from lychee.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops fixed Bug has been resolved labels Oct 12, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @nastijakh, thank you for submitting a ultralytics/docs 🚀 PR! This automated message confirms your contribution was received, and an Ultralytics engineer will assist with the review. 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; the CLA check will comment with signing instructions if needed.
  • ✅ 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

Reviewed the codespell ignore-list additions and the bot-protected-domain exclusions across all three lychee calls. The exclusions are synchronized and the changes address the reported false positives without an evident regression. LGTM; the spelling allowlist remains global to the rendered HTML spellcheck.

@nastijakh
nastijakh marked this pull request as draft October 12, 2026 10:43
@nastijakh
nastijakh marked this pull request as ready for review October 12, 2026 10:45
@glenn-jocher glenn-jocher changed the title Fix website spellcheck and link-check false positives (uber.com, dspace.mit.edu, glossary terms) Fix website glossary spellcheck false positives Oct 12, 2026
@glenn-jocher
glenn-jocher merged commit 75cb7a7 into main Oct 12, 2026
6 checks passed
@glenn-jocher
glenn-jocher deleted the website-spellcheck-link-false-positives branch October 12, 2026 15:52
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 PR #369 has been merged! Thank you @nastijakh, with contributions from @glenn-jocher, for updating the spellcheck ignore list and fixing the Feature Store and Spatial Computing links.

“Alone we can do so little; together we can do so much.” — Helen Keller

These careful fixes help keep the glossary links current and prevent the reported spellcheck false positives.

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

Labels

devops GitHub Devops or MLops fixed Bug has been resolved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants