Skip to content

Commit ea74282

Browse files
accesswatchGitHub Workshop Botclaude
authored
docs(a11y): drop known limitations fixed in #273 (#282)
The Quick Jumps focus outline (#265) and the search box name (#266) were fixed and confirmed on the live site in #273, so they are no longer known limitations or remaining work in the October update. Co-authored-by: GitHub Workshop Bot <workshop@example.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 2b833e3 commit ea74282

3 files changed

Lines changed: 14 additions & 18 deletions

File tree

‎ACCESSIBILITY.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,6 @@ What has been checked:
174174
These are the barriers we know about, what they mean for you, and what to do instead. Please [report any we have missed](#reporting-accessibility-issues).
175175

176176
- **Website testing is partial.** Keyboard, screen reader and manual visual checks of the website's core tasks 1 to 4 are [recorded](admin/ACCESSIBILITY_CORE_FLOWS.md), on Windows only. Not yet run: the accessibility bug report form (task 5), the ePub and braille downloads (task 6), VoiceOver on macOS, and Windows High Contrast. The manual check found two barriers: the breadcrumb is cut off at narrow widths and high zoom ([#280](https://github.com/Community-Access/git-going-with-github/issues/280)), and Chapter 05 uses abbreviations without spelling them out ([#279](https://github.com/Community-Access/git-going-with-github/issues/279)). Workaround for the breadcrumb: the same Home link is in the sidebar as "Workshop Home".
177-
- **The Quick Jumps links hide their focus outline.** On every chapter page, keyboard focus on the Quick Jumps links shows only an underline and a faint background, which is hard to see with low vision ([#265](https://github.com/Community-Access/git-going-with-github/issues/265)). Workaround: the same links are in the "On this page" list and the page headings, which show the normal outline.
178-
- **The site search box is named "Search documentation" but shows "Search docs".** Voice control users may need to say "Search documentation", or move to the field with Tab ([#266](https://github.com/Community-Access/git-going-with-github/issues/266)).
179177
- **Some facilitator guides start headings with emoji**, which screen readers read aloud by name, and some code blocks do not say what they contain ([#264](https://github.com/Community-Access/git-going-with-github/issues/264), [#267](https://github.com/Community-Access/git-going-with-github/issues/267), [#268](https://github.com/Community-Access/git-going-with-github/issues/268)). Learner chapters are not affected by the emoji.
180178
- **The braille files are machine translated.** They are produced automatically by liblouis from a plain-text version of the ePub, so tables are flattened into lines of text and print formatting is not converted to braille formatting. We have no record of review by a certified braille transcriber. Workaround: the ePub, Word or HTML version read with a refreshable braille display keeps the tables and headings.
181179
- **Podcast episodes are companions, not readings.** Episodes use synthetic voices and summarize a chapter rather than reading it word for word. Every episode has a transcript, and the chapter itself is the complete source.
@@ -191,7 +189,7 @@ We publish accessibility progress here, every quarter and after each cohort, and
191189
### October 2026: adopting the framework
192190

193191
- **Completed:** this document; a reworked [accessibility bug report form](https://github.com/Community-Access/git-going-with-github/issues/new?template=accessibility-bug.yml) with only two required fields and an email alternative; a full accessibility checklist in the pull request template; the documentation accessibility check in CI, with its first findings tracked in [#267](https://github.com/Community-Access/git-going-with-github/issues/267); fixes to a skipped heading level (Appendix Z), a second H1 (Appendix L), empty table headers on the registration pages, and a stray line above the title of CONTRIBUTING.md. Earlier in 2026: an EBAE braille file beside the UEB one ([#174](https://github.com/Community-Access/git-going-with-github/issues/174)), and Chapter 11's explanation of the VoiceOver "selection replaced" announcement ([#175](https://github.com/Community-Access/git-going-with-github/issues/175)).
194-
- **Remaining:** run and record the [core flow checks](admin/ACCESSIBILITY_CORE_FLOWS.md); fix the site template findings ([#265](https://github.com/Community-Access/git-going-with-github/issues/265), [#266](https://github.com/Community-Access/git-going-with-github/issues/266)); work through the recorded documentation findings ([#264](https://github.com/Community-Access/git-going-with-github/issues/264), [#268](https://github.com/Community-Access/git-going-with-github/issues/268)); find the cause of [#175](https://github.com/Community-Access/git-going-with-github/issues/175).
192+
- **Remaining:** run and record the [core flow checks](admin/ACCESSIBILITY_CORE_FLOWS.md); work through the recorded documentation findings ([#264](https://github.com/Community-Access/git-going-with-github/issues/264), [#268](https://github.com/Community-Access/git-going-with-github/issues/268)); find the cause of [#175](https://github.com/Community-Access/git-going-with-github/issues/175).
195193
- **Known barriers:** see [Known limitations](#known-limitations).
196194
- **How to help:** issues labeled [`accessibility`](https://github.com/Community-Access/git-going-with-github/issues?q=is%3Aopen+label%3Aaccessibility).
197195

‎html/ACCESSIBILITY.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,8 +386,6 @@ <h2 id="known-limitations">Known limitations</h2>
386386
<p>These are the barriers we know about, what they mean for you, and what to do instead. Please <a href="#reporting-accessibility-issues">report any we have missed</a>.</p>
387387
<ul>
388388
<li><strong>Website testing is partial.</strong> Keyboard, screen reader and manual visual checks of the website&#39;s core tasks 1 to 4 are <a href="admin/ACCESSIBILITY_CORE_FLOWS.html">recorded</a>, on Windows only. Not yet run: the accessibility bug report form (task 5), the ePub and braille downloads (task 6), VoiceOver on macOS, and Windows High Contrast. The manual check found two barriers: the breadcrumb is cut off at narrow widths and high zoom (<a href="https://github.com/Community-Access/git-going-with-github/issues/280">#280</a>), and Chapter 05 uses abbreviations without spelling them out (<a href="https://github.com/Community-Access/git-going-with-github/issues/279">#279</a>). Workaround for the breadcrumb: the same Home link is in the sidebar as &quot;Workshop Home&quot;.</li>
389-
<li><strong>The Quick Jumps links hide their focus outline.</strong> On every chapter page, keyboard focus on the Quick Jumps links shows only an underline and a faint background, which is hard to see with low vision (<a href="https://github.com/Community-Access/git-going-with-github/issues/265">#265</a>). Workaround: the same links are in the &quot;On this page&quot; list and the page headings, which show the normal outline.</li>
390-
<li><strong>The site search box is named &quot;Search documentation&quot; but shows &quot;Search docs&quot;.</strong> Voice control users may need to say &quot;Search documentation&quot;, or move to the field with Tab (<a href="https://github.com/Community-Access/git-going-with-github/issues/266">#266</a>).</li>
391389
<li><strong>Some facilitator guides start headings with emoji</strong>, which screen readers read aloud by name, and some code blocks do not say what they contain (<a href="https://github.com/Community-Access/git-going-with-github/issues/264">#264</a>, <a href="https://github.com/Community-Access/git-going-with-github/issues/267">#267</a>, <a href="https://github.com/Community-Access/git-going-with-github/issues/268">#268</a>). Learner chapters are not affected by the emoji.</li>
392390
<li><strong>The braille files are machine translated.</strong> They are produced automatically by liblouis from a plain-text version of the ePub, so tables are flattened into lines of text and print formatting is not converted to braille formatting. We have no record of review by a certified braille transcriber. Workaround: the ePub, Word or HTML version read with a refreshable braille display keeps the tables and headings.</li>
393391
<li><strong>Podcast episodes are companions, not readings.</strong> Episodes use synthetic voices and summarize a chapter rather than reading it word for word. Every episode has a transcript, and the chapter itself is the complete source.</li>
@@ -401,7 +399,7 @@ <h2 id="progress-updates">Progress updates</h2>
401399
<h3 id="october-2026-adopting-the-framework">October 2026: adopting the framework</h3>
402400
<ul>
403401
<li><strong>Completed:</strong> this document; a reworked <a href="https://github.com/Community-Access/git-going-with-github/issues/new?template=accessibility-bug.yml">accessibility bug report form</a> with only two required fields and an email alternative; a full accessibility checklist in the pull request template; the documentation accessibility check in CI, with its first findings tracked in <a href="https://github.com/Community-Access/git-going-with-github/issues/267">#267</a>; fixes to a skipped heading level (Appendix Z), a second H1 (Appendix L), empty table headers on the registration pages, and a stray line above the title of CONTRIBUTING.md. Earlier in 2026: an EBAE braille file beside the UEB one (<a href="https://github.com/Community-Access/git-going-with-github/issues/174">#174</a>), and Chapter 11&#39;s explanation of the VoiceOver &quot;selection replaced&quot; announcement (<a href="https://github.com/Community-Access/git-going-with-github/issues/175">#175</a>).</li>
404-
<li><strong>Remaining:</strong> run and record the <a href="admin/ACCESSIBILITY_CORE_FLOWS.html">core flow checks</a>; fix the site template findings (<a href="https://github.com/Community-Access/git-going-with-github/issues/265">#265</a>, <a href="https://github.com/Community-Access/git-going-with-github/issues/266">#266</a>); work through the recorded documentation findings (<a href="https://github.com/Community-Access/git-going-with-github/issues/264">#264</a>, <a href="https://github.com/Community-Access/git-going-with-github/issues/268">#268</a>); find the cause of <a href="https://github.com/Community-Access/git-going-with-github/issues/175">#175</a>.</li>
402+
<li><strong>Remaining:</strong> run and record the <a href="admin/ACCESSIBILITY_CORE_FLOWS.html">core flow checks</a>; work through the recorded documentation findings (<a href="https://github.com/Community-Access/git-going-with-github/issues/264">#264</a>, <a href="https://github.com/Community-Access/git-going-with-github/issues/268">#268</a>); find the cause of <a href="https://github.com/Community-Access/git-going-with-github/issues/175">#175</a>.</li>
405403
<li><strong>Known barriers:</strong> see <a href="#known-limitations">Known limitations</a>.</li>
406404
<li><strong>How to help:</strong> issues labeled <a href="https://github.com/Community-Access/git-going-with-github/issues?q=is%3Aopen+label%3Aaccessibility"><code>accessibility</code></a>.</li>
407405
</ul>

0 commit comments

Comments
 (0)