Skip to content
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.

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

Add documentation for keyboard shortcut selecting text across multiple blocks #43164

Merged

Conversation

bengreeley
Copy link
Contributor

What?

Addresses #41168, implementing documentation for the keyboard shortcut for selecting text across multiple blocks (without selecting all of a blocks' text). Feature was originally implemented in #38892.

How?

Adds missing documentation on selecting text between blocks to editor 'Keyboard shortcuts' modal and the 'Are there keyboard shortcuts for Gutenberg' documentation.

Testing Instructions

  1. Open Gutenberg editor
  2. Press shift+alt+h to open Keyboard Shortcuts modal or open the modal by clicking the 3 vertical dots menu and selecting 'Keyboard shortcuts'
  3. Verify the section about selecting text between multiple blocks is added.
  4. Open the 'Are there keyboard shortcuts for Gutenberg' doc and verify new section about selecting text between multiple blocks has been added.

Screen Shot 2022-08-11 at 2 40 43 PM

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Aug 11, 2022
@github-actions
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @bengreeley! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

Copy link
Contributor

@DaisyOlsen DaisyOlsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :-)

Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for updating these docs @bengreeley 👍

The new sections appear as advertised for me. I have a couple of small nits that I've left as inline comments. I believe with those tweaks the wording will be a touch more accurate and this will be ready to merge.

What do you think?

docs/explanations/faq.md Outdated Show resolved Hide resolved
docs/explanations/faq.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies @bengreeley, this one slipped through the cracks of my notifications backlog 😅

I've retested this locally, after rebasing on trunk, and the documentation for selecting text across multiple blocks appears in both locations as advertised.

We might need to rebase this PR branch if re-running the failed tests doesn't get them passing. The failures appear to be unrelated to the changes in this PR.

@bengreeley
Copy link
Contributor Author

Thanks for rebasing @aaronrobertshaw! It's been on my to-do list as well but haven't gotten around to it. Appreciate you taking a look!

Ben Greeley and others added 3 commits August 7, 2023 13:51
Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
@aaronrobertshaw
Copy link
Contributor

I've rebased this PR and will merge once the tests pass

@aaronrobertshaw aaronrobertshaw enabled auto-merge (squash) August 7, 2023 03:53
@aaronrobertshaw aaronrobertshaw added the [Type] Enhancement A suggestion for improvement. label Aug 7, 2023
@aaronrobertshaw aaronrobertshaw merged commit 06e48f6 into WordPress:trunk Aug 7, 2023
49 checks passed
@github-actions github-actions bot added this to the Gutenberg 16.5 milestone Aug 7, 2023
@SiobhyB SiobhyB added the [Type] Developer Documentation Documentation for developers label Aug 16, 2023
@github-actions
Copy link

Warning: Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Accessibility (a11y), [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: [Type] Enhancement, [Type] Developer Documentation, First-time Contributor.

Read more about Type labels in Gutenberg.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants