docs: add alt text to 157 images on the top 20 files - #1779
Open
VeronicaSnyk wants to merge 1 commit into
Open
Conversation
Group B item 7 of the AI-readiness audit. 480 images across 167 files have no alt text. This covers the 20 files with the most, which is 157 images, roughly a third of the backlog. Alt text is derived from each image's own context. 94 of the 157 pages already carried a figcaption describing the image, so that author written text is reused rather than replaced. The remaining 63 are written from the surrounding heading and prose. Two groups needed individual treatment rather than a pattern: the coverage control logos in assets-inventory-components.md and the severity icons in the JetBrains plugin page are inline lookup-table icons where each image means something different, so each names its own state. Only the alt text changes: every one of the 157 edited lines is identical apart from the alt attribute or Markdown alt slot. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
There was a problem hiding this comment.
AI review
No style or structural issues found.
Verified: all 157 added alt texts provide descriptive labels for images across the top 20 pages · alt text style complies with Snyk writing guidelines (no contractions, no Latin abbreviations, active descriptions) · table formatting and figure captions remain intact.
The current head commit 78325e306a2af7e7c7360a07db342536acdd65a1 is reviewed.
Sent by Cursor Automation: PR review for User Docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Group B item 7 of the September 2026 AI-readiness audit.
480 images across 167 files have no alt text. This PR covers the 20 files with the most — 157 images, roughly a third of the backlog — which is the scope the audit recommended.
Where the text comes from
94 of the 157 images already had a
<figcaption>describing them. That text is author-written and already reviewed, so it is reused as the alt text rather than replaced with something new.The remaining 63 are written from the page's own heading and surrounding prose. Nothing is asserted about a screenshot beyond what the page already states — where the page says "Click Configure MCP Servers on the MCP Servers tab", the alt text is "Configure MCP Servers button on the MCP Servers tab".
Two groups that needed individual treatment
Most images follow a pattern. Two sets do not, because they are inline icons in lookup tables where each image means something different and generic alt text would actively mislead:
assets-inventory-components.md— six coverage control logos, each a different state:run-an-analysis-with-the-jetbrains-plugin.md— four severity icons, named individually: Critical, High, Medium, Low.In both cases the meaning was taken from the adjacent table cell.
Verification
tools/alt-text-check(the check added in docs: AI-readiness Group A fixes #1725)alt=""and Markdown.Most updates fill empty
alt=""attributes on<figure><img>tags or add alt strings to Markdown![]()images. Where a<figcaption>already existed, that text is copied intoalt; otherwise descriptions are taken from nearby headings and steps (for example MCP setup in Cline/Copilot/Devin).Two lookup-table exceptions get state-specific alt text instead of generic labels: the six asset inventory coverage control icons and the four JetBrains severity icons in table cells.
No product behavior, APIs, or config defaults change—only documentation accessibility for screen readers and the alt-text audit check.
Reviewed by Cursor Bugbot for commit 78325e3. Bugbot is set up for automated code reviews on this repo. Configure here.