Accessibility Conformance Report for GitHub Docs

(Based on VPAT® Version 2.4)

Report Date

This report was last updated on June 5, 2024.

Product Description

GitHub Docs provide comprehensive guides, tutorials, and reference material on how to use GitHub’s various features and services. It’s a valuable resource for developers of all skill levels to effectively use GitHub’s platform.

Contact Information

Please share questions or comments on the accessibility community discussion page.

Scope

The scope of this report is limited to content on docs.github.com:

  • Documentation
  • Version switcher
  • Search GitHub docs
  • Language switcher
  • Feedback
  • Panel navigation and controls

Evaluation Methods Used

Scenarios were tested using:

  • Keyboard-only interactions
  • JAWS and NVDA with Google Chrome
  • axe
  • Colour Contrast Analyzer
  • Platform features such as high contrast and zoom

Applicable Standards/Guidelines

This report reflects outstanding issues found by an audit based on the level A and AA criteria of the Web Content Accessibility Guidelines version 2.1 (WCAG 2.1 AA).

Terms

  • Supports: The functionality of the product has at least one method that meets the criterion without known defects or meets with equivalent facilitation.
  • Partially Supports: Some functionality of the product does not meet the criterion.
  • Does Not Support: The majority of product functionality does not meet the criterion.
  • Not Applicable: The criterion is not relevant to the product.
  • Not Evaluated: The product has not been evaluated against the criterion.

WCAG 2.1

Level A Success Criteria

Success Criteria Conformance Level Remarks and Explanations
1.1.1 Non-text Content

Supports
1.2.1 Audio-only and Video-only (Prerecorded)

Supports
1.2.2 Captions (Prerecorded)

Supports
1.2.3 Audio Description or Media Alternative

Supports
1.3.1 Info and Relationships

Partially Supports

Exceptions include:

  • [GitHubDocs7.1] [GitHub docs-Video] The screen reader does not announce the status information-'Connecting' on invoking 'casting device' button.
  • [GitHubDocs7.1] [GitHub Docs-Video] Screen reader announcing 'Back to tab' control that is not visible on the screen.
1.3.2 Meaningful Sequence

Supports
1.3.3 Sensory Characteristics

Supports
1.4.1 Use of Color

Supports
1.4.2 Audio Control

Supports
2.1.1 Keyboard

Partially Supports

Exceptions include:

  • [GitHubDocs30.2] [GitHub Docs Audit 2-GraphQL Explorer] The tooltip for 'Execute Query' button is not accessible with keyboard.
  • [GitHubDocs7.1] [Keyboard Naviagation-GitHub Docs-Video] Tooltip defined for ‘Picture in picture’ icon which appears after activating 'Play on tv' button is not keyboard accessible.
2.1.2 No Keyboard Trap

Supports
2.1.4 Character Key Shortcuts

Supports
2.2.1 Timing Adjustable

Supports
2.2.2 Pause Stop Hide

Supports
2.3.1 Three Flashes or Below Threshold

Supports
2.4.1 Bypass Blocks

Supports
2.4.2 Page Titled

Supports
2.4.3 Focus Order

Partially Supports

Exceptions include:

  • [GitHubDocs7.1] [GitHub Docs-Video] On invoking the 'Esc' key, focus is not retaining to the same control “full screen” .
  • [GitHubDocs7.1] [GitHub Docs-Video] Keyboard focus moving to hidden element after seek slider.
2.4.4 Link Purpose (In Context)

Supports
2.5.1 Pointer Gestures

Supports
2.5.2 Pointer Cancellation

Supports
2.5.3 Label in Name

Partially Supports

Exceptions include:

  • [GitHubDocs30.1] [GitHub Docs Audit 2-GraphQL Explorer] Visual name and aria-label are different for 'Docs' control.
2.5.4 Motion Actuation

Supports
3.1.1 Language of Page

Supports
3.2.1 On Focus

Supports
3.2.2 On Input

Supports
3.3.1 Error Identification

Supports
3.3.2 Labels or Instructions

Supports
4.1.1 Parsing

Supports
4.1.2 Name Role Value

Partially Supports

Exceptions include:

  • [GitHubDocs30.5] [Screen Readers-GitHub Docs Audit 2-GraphQL Explorer] The '+' button is not descriptive.
  • [GitHubDocs7.1][Screen Readers-GitHub Docs-Video] Ensure aria-attributes are allowed for an element's role.
  • [GitHubDocs7.1] [GitHub Docs-Video] Screen reader not announcing the ‘State of ‘options’ button.

Level AA Success Criteria

Success Criteria Conformance Level Remarks and Explanations
1.2.4 Captions (Live)

Supports
1.2.5 Audio Description (Prerecorded)

Supports
1.3.4 Orientation

Supports
1.3.5 Identify Input Purpose

Supports
1.4.3 Contrast (Minimum)

Supports
1.4.4 Resize text

Supports
1.4.5 Images of Text

Supports
1.4.10 Reflow

Partially Supports

Exceptions include:

  • [GitHubDocs7.1][GitHub Docs-Video] Video controls getting disappeared when the viewport is set to 320*256 pixels.
1.4.11 Non-text Contrast

Supports
1.4.12 Text-spacing

Partially Supports

Exceptions include:

  • [GitHubDocs7.1] [GitHub Docs-Video] Volume slider is getting truncated after applying text spacing tool.
1.4.13 Content on Hover or Focus

Supports
2.4.5 Multiple Ways

Supports
2.4.6 Headings and Labels

Supports
2.4.7 Focus Visible

Partially Supports

Exceptions include:

  • [GitHubDocs7.1] [GitHub Docs-Video] The keyboard focus indicator is not visible for 'Tata Play' button.
3.1.2 Language of Parts

Supports
3.2.3 Consistent Navigation

Supports
3.2.4 Consistent Identification

Supports
3.3.3 Error Suggestion

Supports
3.3.4 Error Prevention (LFD)

Supports
4.1.3 Status Messages

Partially Supports

Exceptions include:

  • [GitHubDocs4.3] [GitHub Docs Audit 2-Protected Branch(API Reference)] The screen reader does not announce status message information on invoking the Copy to clipboard button.

Disclaimer

© 2023 GitHub Inc.. All rights reserved. The names of actual companies and products mentioned herein may be the trademarks of their respective owners. The information contained in this document represents the current view of GitHub Inc.on the issues discussed as of the date of publication. GitHub cannot guarantee the accuracy of any information presented after the date of publication.

GitHub’s WCAG 2.1 conformance reports provide the information included in ITI’s “VPAT® 2.4Rev WCAG (March 2022)” template. “Voluntary Product Accessibility Template” and “VPAT” are registered service marks of the Information Technology Industry Council (ITI). This document includes material copied from or derived from the Web Content Accessibility Guidelines (WCAG 2.1). Copyright © 2017-2018 W3C® (MIT, ERCIM, Keio, Beihang). This document is not the Web Content Accessibility Guidelines (WCAG) and should not be used as a substitute for it. Excerpts of WCAG are referenced solely for purposes of detailing GitHub’s conformance with the relevant provisions. A full and complete copy of the Guidelines is available from the W3C WAI.

GitHubregularly updates its websites and provides new information about the accessibility of products as that information becomes available. Customization of the product voids this conformance statement from GitHub. Customers may make independent conformance statements if they have conducted due diligence to meet all relevant requirements for their customization. Please consult with Assistive Technology (AT) vendors for compatibility specifications of specific AT products. This document is for informational purposes only. GitHubMAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS DOCUMENT.

Back to conformance reports