Repository navigation
docs: give screenshots their own alt text and fill empty table headers - #30873
Open
nickvigilante wants to merge 1 commit into
Open
nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
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
Contributor
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.
|
This branch has not been deployed
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
1 participant
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.
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.