Skip to content

Conversation

kellychoffman
Copy link
Contributor

@kellychoffman kellychoffman commented Sep 1, 2021

Part of an overall call to update block descriptions to more clear, consistent, and educational.

Before:

Describe in a few words what the website is about. The tagline can be used in search results or when sharing on social networks even if it's not displayed in the theme design.

After:

Describe in a few words what this site is about. This is important for search results, sharing on social media, and gives overall clarity to visitors.

Feedback welcome! (Copy is hard.) Props @annezazu for the collab.

@kellychoffman kellychoffman added [Type] Copy Issues or PRs that need copy editing assistance [Type] Enhancement A suggestion for improvement. labels Sep 1, 2021
@annezazu annezazu self-requested a review September 1, 2021 19:52
Copy link
Contributor

@annezazu annezazu left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@mtias
Copy link
Member

mtias commented Sep 2, 2021

For some of these blocks I don't think concise is necessarily the target and it can expand a bit more. The tagline, for example, can generally be confusing, and it's fine if it takes a few more lines to explain. What is the clarity that it gives visitors, for example? It won't necessarily be shown in search results, but it might be used in social media shares, etc.

@kellychoffman
Copy link
Contributor Author

kellychoffman commented Sep 2, 2021

Social media added back in!

Describe in a few words what this site is about. This is important for search results, sharing on social media, and gives overall clarity to visitors.

It's a few words shorter than the previous version, but that wasn't the main point of this clean up iteration. As far as the clarity question: Site descriptions are there to describe/clarify/give clarity to your users what your site is about. Agree that it most often is seen in social channels today.

@Mamaduka
Copy link
Member

Mamaduka commented Sep 7, 2021

@mtias should we merge the update description?

@aristath aristath force-pushed the update-site-title-description branch from db9d1d1 to 9ff7c21 Compare May 3, 2022 10:21
@aristath
Copy link
Member

aristath commented May 3, 2022

There were conflicts in this PR because files changed since the PR was initially pushed.
I rebased it resolving merge conflicts and should be ready again.

@aristath
Copy link
Member

Do we still want to merge this one? If yes, then I think the docs should be updated to prevent the tests from failing (see failing tests in https://github.com/WordPress/gutenberg/runs/6271589009?check_suite_focus=true) 👍

@t-hamano
Copy link
Contributor

I came across this PR while checking for PRs that haven't been reviewed in a long time. I also think this PR is still valid, but I think the conflict needs to be resolved and the documentation updated (npm run docs:build).

@Mamaduka Mamaduka force-pushed the update-site-title-description branch from 9ff7c21 to 2ad5e81 Compare July 11, 2025 14:11
Copy link

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: kellychoffman <kellychoffman@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: annezazu <annezazu@git.wordpress.org>
Co-authored-by: mtias <matveb@git.wordpress.org>
Co-authored-by: aristath <aristath@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

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

@Mamaduka Mamaduka added [Block] Site Tagline Affects the Site Tagline Block and removed [Type] Enhancement A suggestion for improvement. labels Jul 11, 2025
Copy link

Flaky tests detected in 2ad5e81.
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/16222127644
📝 Reported issues:

@Mamaduka Mamaduka merged commit 90adbe9 into trunk Jul 11, 2025
64 of 67 checks passed
@Mamaduka Mamaduka deleted the update-site-title-description branch July 11, 2025 14:45
@github-actions github-actions bot added this to the Gutenberg 21.3 milestone Jul 11, 2025
cbravobernal pushed a commit that referenced this pull request Jul 15, 2025
Co-authored-by: kellychoffman <kellychoffman@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: annezazu <annezazu@git.wordpress.org>
Co-authored-by: mtias <matveb@git.wordpress.org>
Co-authored-by: aristath <aristath@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Site Tagline Affects the Site Tagline Block [Type] Copy Issues or PRs that need copy editing assistance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants