Fix website spelling check for inline scripts#302
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
👋 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 workflow change looks clean and targeted. Copying the rendered site into a temporary workspace before stripping inline <script>/<style> blocks is a reasonable way to reduce codespell noise, and the quoting/grouped env writes improve shell safety without changing behavior. I didn't find any clear bugs or maintainability issues in the diff.
|
Merged! 🎉 Thanks, @glenn-jocher, for sharpening the docs link-check workflow and making CI feedback cleaner, quieter, and more useful for everyone. “Simplicity is the ultimate sophistication.” — Leonardo da Vinci This update reflects that perfectly: by stripping out JS/CSS noise and focusing spellcheck on rendered HTML text, the workflow now highlights real documentation issues instead of distracting false positives. That means a smoother experience for contributors and more reliable signals for maintainers. Really valuable improvement to the docs pipeline. |
Summary
actionlintpassesValidation
actionlint .github/workflows/links.ymlhroughandreleas; patched scan reports no spelling outputtehis still reported while script/style-only typos are ignored🛠️ PR Summary
Made with ❤️ by Ultralytics Actions
🌟 Summary
🧹 This PR improves the docs link-check workflow by making HTML spellchecking smarter, cleaner, and less noisy in CI results.
📊 Key Changes
links.ymlworkflow to runcodespellon rendered HTML text only, instead of also checking embedded JavaScript and CSS content..codespell-htmlcopy of the built site before spellchecking, so files can be safely preprocessed without touching the original output.<script>and<style>blocks from HTML files before running spelling checks, reducing false positives from code payloads..codespell-htmldirectory.$GITHUB_ENV.🎯 Purpose & Impact