Repository navigation
docs: give screenshots their own alt text and fill empty table headers - #30873
Conversation
An accessibility sweep of the beta docs site found screenshots whose alt text repeats the italic caption beside them, so screen readers read the same words twice, and tables with an empty top-left header cell, which leaves the row-label column unnamed. Each alt now describes what the image shows, and each corner cell names its column. Assisted-by: AI
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.
|
chrifro
left a comment
There was a problem hiding this comment.
Seems good. But I couldn't test it
Open each production page below. Expected: the screenshots and tables look the same as before, except the four tables now show a word in their top-left header cell.
I couldn't find this to verify
|
@chrifro thanks for flagging this, and sorry: the QA steps pointed at production, which still showed the old version before merge, and the "Preview" links went to GitHub's file view instead of the rendered docs. I ran axe (
13 violations went to 0. Testing also turned up a mismatch: the captions on Add a language called the Programming Languages parameter a "dropdown", but it's a multi-select. That fix is in #31133. 🤖 Generated by Coder Agents on behalf of @nickvigilante. |
Summary
An axe sweep of every page on https://coder.com/beta-docs (coder/docs-engine#224) found two content-side problems. Nine screenshots have alt text identical to the italic caption right after them, so screen readers read the same words twice (axe
image-redundant-alt). Four hand-written tables have an empty top-left header cell, which leaves their row-label column without a name (axeempty-table-header). This fixes both. These are content fixes onmainonly; earlier release lines keep the old text.Findings
audit-logs.mdadmin/networking/port-forwarding.mdremote-desktops.md<div class="tab">typoFix
Each of the nine screenshots gets alt text that describes what it shows (for example, "Preset dropdown with Ruby Development added between Full Stack and Web Development"), and keeps its caption. The corner cells become "Permission" (Groups and roles), "Component" (air-gapped comparison), "Scenario" (scale-testing workloads) and "Input" (workspace tags). Tables were re-padded with
markdown-table-formatter.QA
altdiffers from the italic caption under it.Pages to compare
Testing
markdownlint-cli2andmarkdown-table-formatterover the eight changed files: 0 errors. Re-running the sweep after merge should dropimage-redundant-altand the four tables'empty-table-headerfindings from@main.Upstream
No: these are Coder content fixes, not Fumadocs bugs.
Linear: DOCS-1303
🤖 Built with AI assistance.