WordPress / Documentation-Issue-Tracker

Issue Tracker for the WordPress Documentation team.
https://make.wordpress.org/docs/
Other
81 stars 42 forks source link

[HelpHub] Feedback on Synced Patterns (Reusable blocks) #1703

Open zzap opened 2 weeks ago

zzap commented 2 weeks ago

URL of the Page with the Issue

https://wordpress.org/documentation/article/reusable-blocks/

Originally reported by

As noted below

Report content (issue description)

You have two pages that refer to each other and neither answers the question of how to “detach” a synced pattern.

The article comparing-patterns-template-parts-and-reusable-blocks says:

After creating a synced pattern, you can ‘Detach’ it to a regular block, and edit the block without affecting your already saved synced pattern. For more information, you can learn more in the Synced Pattern article.

which links to this page where it says the same thing in the first paragraph, only without a link to an article with the answer.

By https://profiles.wordpress.org/linuxarchitect/

In the first paragraph, you say, “For more information, you can learn more in the Synced Pattern article.”

It would be helpful if this was a link to the Synced Pattern article.

This feedback could be applied more broadly as one of my biggest frustrations with using .org documentation is referencing other pieces of documentation without actually linking to those pieces of documentation and leaving it up to the user to find what y’all are talking about. The developer docs are particularly bad about this.

By https://profiles.wordpress.org/thirdeyerose/

Section of Page with the issue

Why is this a problem?

Suggested Fix

github-actions[bot] commented 2 weeks ago

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

atachibana commented 2 weeks ago

New section "Detaching a Synced Pattern" should be created with new image as below, and set a link on the Detach to that section. Also, the last line "For more information, you can learn more in the Synced Pattern article." should be removed because it is the circular referencing.

Detaching a Synced Pattern

After inserting the Synced Pattern you want to use, make sure to select ‘Detach‘ (formerly known as “Convert to Regular Block“) option shown below if you wish to make any changes to the block on that page or post only. Note that this option won’t be available if the Synced Pattern is locked. Image