Skip to content

Improve documentation for project board keyboard shortcut #1034

Closed
@megbird

Description

@megbird

From @OKiMaureen:

What feature or product is affected?

Improve documentation for project board keyboard shortcut

https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/keyboard-shortcuts#project-boards

What is the new or expected behavior?

The user said:

I would suggest improving the keyboard shortcut documentation for project boards to be more clear about using enter to begin the process of moving cards.

This can be done by adding a separate description at the top that one needs to enter moving mode first.

Reason being that usually, keyboard shortcuts that are in a list like that don't depend on one another, Which is why I merely scanned the list for "move card to the top" and didn't think that any of the other entries in the list would be relevant.

How is the old or inaccurate behavior currently documented?

The Keyboard shortcuts for project boards are in a list which doesn't insinuate that the shortcuts depend on one another.

Who does this affect?

Users who make use of project board keyboard shortcuts

What is the impact to users?

Confusion.

Additional information

Example user from zendesk :

According to the docs, you'll have to first press enter to begin the process of moving a card. After that ↑ moves it up one step & control ↑ moves it to the top of the column. To finish the move press enter again.

I would suggest to improve the keyboard shortcut modal to be more clear about that though.
Such as adding a separate description at the top that one needs to enter moving mode first.
Reason being that usually, keyboard shortcuts that are in a list like that don't depend on one another. Which is why I merely scanned the list for "move card to the top" and didn't think that any of the other entries in the list would be relevant.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomershelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions