Skip to content

docs: adopt the Open Source Accessibility Framework - #269

Merged
accesswatch merged 1 commit into
mainfrom
osaf/adopt-framework
Oct 28, 2026
Merged

accesswatch merged 1 commit into
mainfrom
osaf/adopt-framework

Conversation

@accesswatch

@accesswatch accesswatch commented Oct 28, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Adopts GitHub's Open Source Accessibility Framework in the workshop repository: a full ACCESSIBILITY.md, an automated documentation accessibility check in CI, a reworked accessibility issue form, an accessibility checklist in the pull request template, written test plans for the core flows, and a quarterly review reminder. Participation is an improvement commitment, not a certification.

Changes

  • ACCESSIBILITY.md (new): priorities, contributor expectations and interface requirements, reporting on GitHub or by email, severity, how we respond, ways to take part and accommodations, ownership (Jeff Bishop, @accesswatch), dependencies and upstream blockers (Screen Reader Anounce Authorize VS Code Button As Unavailable #70, [A11Y] Mac reads Selection replaced when typing in an editor #175), supported environments, known limitations, progress updates, recognition with consent, reusable materials, and framework progress.
  • scripts/check-docs-accessibility.js (new), its baseline, tests and .github/workflows/docs-accessibility.yml: checks 154 Markdown files for H1 and heading levels, alt text, link text, table headers, code block languages and emoji; blocks only new findings. The 264 recorded findings are tracked in Known findings from the documentation accessibility check #267.
  • .github/workflows/accessibility-review-reminder.yml (new): opens a quarterly accessibility review issue with issue counts and a checklist. Set up; it has not run yet.
  • admin/ACCESSIBILITY_CORE_FLOWS.md (new): keyboard, screen reader and manual checks for six core tasks, all marked not yet run, and the documentation review record.
  • .github/ISSUE_TEMPLATE/accessibility-bug.yml: two required fields instead of seven, a "Where" field, severity, more assistive technology options, email alternative, willingness to test. config.yml gets a non-GitHub reporting link.
  • .github/PULL_REQUEST_TEMPLATE.md: full content and interface accessibility checklist.
  • CONTRIBUTING.md, README.md, .github/README.md: pointers to the new document, check and workflows.
  • Documentation fixes: skipped heading in Appendix Z, second H1 in Appendix L, empty table headers on both registration pages, stray line above the CONTRIBUTING.md title.
  • html/ rebuilt with npm run build:html.

Related issues opened or labeled for this: #264, #265, #266, #268 (good first issue), #267 (tracking), #175 (help wanted), #70 and #174 (labeled accessibility).

How to Review

Start with ACCESSIBILITY.md; check the ownership section, the response commitments and the known limitations are ones you are happy to publish. No keyboard or screen reader test of the site was run in this change; those records are marked "Not yet run".

Accessibility Checklist

  • Headings sequential, one H1 per new page (checked by the new check)
  • Descriptive link text, no emoji, code blocks with a language in new files
  • npm run check:accessibility, npm run validate:authoritative-sources, npm run test:automation, npm run test:provisioning and npm run build:html pass locally
  • N/A Interface items: no interface code changed

Testing

  • Tested with: Node.js 22 locally; CI on this pull request
  • Screen reader used: none (documentation and workflow change)

https://claude.ai/code/session_01PmRBrUTuhzYnQBFxUCN6Vr


Generated by Claude Code

Add ACCESSIBILITY.md with priorities, contributor expectations,
interface requirements, reporting (form and email), severity, response,
ways to take part and accommodations, ownership, dependencies and
upstream blockers, supported environments, known limitations, progress
updates, recognition with consent and reusable materials.

Add a dependency-free Markdown accessibility check with a baseline,
its tests and a CI workflow; a quarterly accessibility review reminder
workflow; and test records for the core flows in
admin/ACCESSIBILITY_CORE_FLOWS.md (written, not yet run).

Rework the accessibility bug report form (two required fields, severity,
email alternative), add a full accessibility checklist to the pull
request template, point CONTRIBUTING.md and README.md at the new
document, and fix four documentation findings: a skipped heading level
in Appendix Z, a second H1 in Appendix L, empty table headers on the
registration pages, and a stray line above the CONTRIBUTING.md title.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PmRBrUTuhzYnQBFxUCN6Vr
@github-actions

Copy link
Copy Markdown
Contributor

Peer Review Assigned

Hi @accesswatch! Your PR has been automatically paired with @taylorarndt for peer review.

For @taylorarndt:

This is a great opportunity to practice code review skills! Here's what to look for:

Content Quality:

  • Does the change accomplish what the issue describes?
  • Is the writing clear and helpful?
  • Are there any typos or grammar issues?

Accessibility:

  • Proper heading hierarchy (H1 → H2 → H3, no skips)?
  • Descriptive link text (not "click here")?
  • Alt text on images?
  • [TODO] markers removed?

Documentation:

  • Code blocks are properly formatted?
  • Tables have headers?
  • References/links work correctly?

Review Guidelines:

  • Be kind and constructive
  • Suggest improvements, don't just point out problems
  • Ask questions if something is unclear
  • Approve when ready or request changes with explanation

Resources:


Pairing by Learning Room Grouping Engine

@accesswatch
accesswatch merged commit 53b80e9 into main Oct 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants