Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Improve documentation for project board keyboard shortcut #1034
Comments
This comment was marked as spam.
This comment was marked as spam.
|
Hello @megbird , I have an idea to fix this issue #1034 . If we add a popup which will contain gif and gif popup related to respective shortcut key will get activated when user will hover the shortcut keys image or text . That would surely help beginners to remember the shortcut keys .I m figuring out how this idea can be implemented since I m beginner in contribution .Please help me in fixing this doc . This is an one sample of popup Thank you |
|
For each row where it's applicable, we can make the shortcut clearer by saying:
and other similar edits wherever applicable in thatt section of the article. Let me know if you have any questions! |
|
Ya surely like to contribute to Github docs . But I m new to contribution process , please guide me in the process . I will surely fix the issue #1034 .Thank you . |
|
@megbird how can I edit the keyboard shortcut part . |
|
|
Done with the minor fixes for open issue number github#1034 .
|
@megbird @janiceilene I have done the changes in the keyboard shortcut section . Please have a glance whether I have done it properly or not . |
|
How can i contribute to this issue? Can anyone here to help me to understand it properly? |
This comment was marked as spam.
This comment was marked as spam.
|
@himanshu211raj There is a pull request waiting for review already. There are other available issues with the help wanted label |
* Improve documentation issue no #1034 Done with the minor fixes for open issue number #1034 . * Increasing the importance I wanted to delete a branch, but I couldn't in spite of reading this document. The problem was, the branch I wanted to delete was the default branch. Even though it is stated in this document, it was not given enough importance that everyone would see it. * typo A small type in the comments * Update setting-up-your-development-environment-to-create-a-github-app.md Fix two small typos. * properly capitalize "macOS" * Clarify GH password requirements * Change " to ` As done in the description of `master` * " to ` in DE * " to ` in PT * " to ` in RU * Fix typo metadata-syntax-for-github-actions.md Fix typo for metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions * chore: Remove bolding from headings * Removed deprecated echo set-env instruction * fix typo (#1516) Co-authored-by: hubwriter <[email protected]> * Remove extraneous grammar period which breaks the compare URL (#1252) * Remove extraneous grammar period which breaks the compare URL * Update data/reusables/repositories/two-dot-diff-comparison-example-urls.md Co-authored-by: Nick Schonning <[email protected]> Co-authored-by: Nick Schonning <[email protected]> Co-authored-by: hubwriter <[email protected]> * Revert "" to ` in RU" This reverts commit d484fd6. * Revert "" to ` in PT" This reverts commit fab62f0. * Revert "" to ` in DE" This reverts commit 78abcd6. * Change md This squashes all the translation commits and their deletion. * Update content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: Atharva Shirdhankar <[email protected]> Co-authored-by: Aakarsh B <[email protected]> Co-authored-by: Aritra Roy Gosthipaty <[email protected]> Co-authored-by: Guilherme Macedo <[email protected]> Co-authored-by: Stephen Wade <[email protected]> Co-authored-by: Shao Yang Hong <[email protected]> Co-authored-by: a2br <[email protected]> Co-authored-by: Cas van Dinter <[email protected]> Co-authored-by: Nick Schonning <[email protected]> Co-authored-by: Antoine Rondelet <[email protected]> Co-authored-by: Shati Patel <[email protected]> Co-authored-by: Meg Bird <[email protected]> Co-authored-by: ねず <[email protected]> Co-authored-by: hubwriter <[email protected]> Co-authored-by: Ilia <[email protected]> Co-authored-by: a2br <[email protected]> Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: Jason Etcovitch <[email protected]>
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
enterto 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 :