Skip to content

Documentation: VisualEditorGlobalKeyboardShortcuts, TextEditorGlobalKeyboardShortcuts editor components#62585

Closed
colorful-tones wants to merge 2 commits intoWordPress:trunkfrom
colorful-tones:add/VisualEditorGlobalKeyboardShortcuts-docs
Closed

Documentation: VisualEditorGlobalKeyboardShortcuts, TextEditorGlobalKeyboardShortcuts editor components#62585
colorful-tones wants to merge 2 commits intoWordPress:trunkfrom
colorful-tones:add/VisualEditorGlobalKeyboardShortcuts-docs

Conversation

@colorful-tones
Copy link
Copy Markdown
Member

What? & Why?

Addresses two items in #60358

Adding documentation to existing editor components can help with any of the following:

  • encourages knowledge sharing and quicker onboarding for future devs
  • supports maintenance and troubleshooting
  • mitigates risk

How?

Add a JSDoc comment to the VisualEditorGlobalKeyboardShortcuts and updated TextEditorGlobalKeyboardShortcut for consistency components and run npm run docs:build to populate the README with the newly added documents.

@colorful-tones colorful-tones enabled auto-merge (squash) June 14, 2024 14:48
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 14, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: colorful-tones <colorful-tones@git.wordpress.org>
Co-authored-by: akasunil <sunil25393@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@shail-mehta shail-mehta added the [Type] Developer Documentation Documentation for developers label Jun 15, 2024
@akasunil
Copy link
Copy Markdown
Member

We can close this PR since the changes are covered by #62710

auto-merge was automatically disabled October 17, 2024 18:04

Pull request was closed

@colorful-tones colorful-tones deleted the add/VisualEditorGlobalKeyboardShortcuts-docs branch October 17, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants