Skip to content

Introduce gh accessibility help topic highlighting GitHub CLI accessibility experiences #10890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 30, 2025
Merged

Introduce gh accessibility help topic highlighting GitHub CLI accessibility experiences #10890

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
274a09b
Initial `gh accessibility` command draft
andyfeller Apr 23, 2025
d7e2468
Update a11y text based on draft feedback
andyfeller Apr 28, 2025
096106a
Apply suggestions from code review
andyfeller Apr 30, 2025
2fd1a45
Update pkg/cmd/accessibility/accessibility.go
andyfeller Apr 30, 2025
c20138d
Update pkg/cmd/accessibility/accessibility.go
andyfeller Apr 30, 2025
830335d
PR feedback
andyfeller Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Melissa Xie <[email protected]>
  • Loading branch information
@andyfeller @mxie
andyfeller and mxie authored Apr 30, 2025
commit 096106a3d703ce9c8177b6608b58f6338f5478f0
14 changes: 6 additions & 8 deletions pkg/cmd/accessibility/accessibility.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func NewCmdAccessibility(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "accessibility",
Aliases: []string{"a11y"},
Short: "Learn about GitHub CLI accessibility experiences",
Short: "Learn about GitHub CLI's accessibility experiences",
Long: longDescription(opts.IO),
Hidden: true,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down Expand Up @@ -87,7 +87,7 @@ func longDescription(io *iostreams.IOStreams) string {
Text interfaces often use color for various purposes, but insufficient contrast
or customizability can leave some users unable to benefit.

To create a more accessible experience, the GitHub CLI will use color palettes
For a more accessible experience, the GitHub CLI can use color palettes
based on terminal background appearance and limit colors to 4-bit ANSI color
palettes, which users can customize within terminal preferences.

Expand Down Expand Up @@ -115,8 +115,7 @@ func longDescription(io *iostreams.IOStreams) string {
of the screen, which can be difficult for speech synthesizers or braille displays
to accurately detect and read.

To create a more accessible experience, the GitHub CLI gives users the ability to
disable this interactivity while providing a similar experience using
For a more accessible experience, the GitHub CLI can provide a similar experience using
non-interactive prompts for user input.

To enable this experience, use one of the following methods:
Expand All @@ -126,12 +125,11 @@ func longDescription(io *iostreams.IOStreams) string {
%[5]s

Motion-based spinners communicate in-progress activity by manipulating the
terminal cursor to create a spinning effect, which can be difficult for users
terminal cursor to create a spinning effect, which may cause discomfort to users
with motion sensitivity or miscommunicate information to speech synthesizers.

To create a more accessible experience, the GitHub CLI gives users the ability to
disable this interactivity while providing a similar experience using text-based
progress indicators.
For a more accessible experience, this interactivity can be disabled in favor
of text-based progress indicators.

To enable this experience, use one of the following methods:
- Run %[1]sgh config set spinner disabled%[1]s
Expand Down
Loading