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

Update and restructure the Editor Hooks doc. #61596

Merged
merged 4 commits into from
May 15, 2024

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented May 12, 2024

What?

This PR updates the Editor Hooks doc and does a bit of restructuring.

Why?

In my work to update/enhance the Curating the Editor Experience documentation, I have been identifying other areas of the documentation that are related and need updating. This Editor Hooks doc could use more examples and some restructuring. I updated it to place greater emphasis on block_editor_settings_all and a few additional examples of how to use the hook. Rather than completely recreate these examples in the Curating the Editor Experience section, it's better to improve the source doc and then link to it.

I would consider this PR a "first pass". There is probably a lot more we can add to the Editor Hooks doc.

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label May 12, 2024
@ndiego ndiego self-assigned this May 12, 2024
Copy link

github-actions bot commented May 12, 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: ndiego <ndiego@git.wordpress.org>
Co-authored-by: juanmaguitar <juanmaguitar@git.wordpress.org>

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

@juanmaguitar
Copy link
Contributor

Would it make sense to create an example at block-development-examples with all these restrictions/enhancements and provide a link to it so these code examples can be seen in action?

If you agree, for the sake of this PR, it would be enough to create the issue for this new example.

@juanmaguitar juanmaguitar self-requested a review May 13, 2024 16:34
@ndiego ndiego enabled auto-merge (squash) May 13, 2024 18:19
Copy link

Flaky tests detected in fce61ce.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9095300664
📝 Reported issues:

@ndiego ndiego merged commit d56f77e into trunk May 15, 2024
61 checks passed
@ndiego ndiego deleted the docs/update-editor-filters-doc branch May 15, 2024 13:13
@github-actions github-actions bot added this to the Gutenberg 18.4 milestone May 15, 2024
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
2 participants