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

Docs: Clarify the status of the wp-block-styles theme support, and its intent #58915

Conversation

andrewserong
Copy link
Contributor

@andrewserong andrewserong commented Feb 12, 2024

What?

Update the docs for the wp-block-styles theme support to clarify its intent to be used in classic themes, and that block themes should be adding styles to theme.json instead of depending on the opinionated styles of this theme support feature.

Why?

Thanks to @simison for flagging that the docs here don't nudge anyone toward baking desired styles in to theme.json for block themes. While it might be easier for themes to use this theme support, they're not guaranteed to work well with block themes or to avoid styling conflicts with rules from global styles.

How?

Update the docs hosted at: https://developer.wordpress.org/block-editor/how-to-guides/themes/theme-support/#default-block-styles

Testing Instructions

Does this read okay, and is the information accurate? I've based that changes here on discussions from @carolinan and @tellthemachines, in particular on #57841 (comment), but it'd be good to double-check that I got the overall idea right, as I could very well be missing some context about this theme support!

Testing Instructions for Keyboard

Screenshots or screencast

Copy link

github-actions bot commented Feb 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: andrewserong <andrewserong@git.wordpress.org>
Co-authored-by: ramonjd <ramonopoly@git.wordpress.org>
Co-authored-by: carolinan <poena@git.wordpress.org>

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

@carolinan
Copy link
Contributor

Can there be a new subheading above this section, because it can still read as if
"Without these rules, the block would result in a broken layout containing no columns at all." .... applies to wp-block-styles.

@andrewserong
Copy link
Contributor Author

Oh, great point @carolinan! I've added an Opinionated block styles heading. Happy to update any of the wording, of course!

Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

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

Nice

docs/how-to-guides/themes/theme-support.md Outdated Show resolved Hide resolved
Co-authored-by: Ramon <ramonjd@users.noreply.github.com>
@andrewserong
Copy link
Contributor Author

Thanks for the review @ramonjd! This PR isn't urgent, so I'll leave it overnight in case there's any other feedback, and then will merge it in tomorrow.

@andrewserong andrewserong merged commit 7011e5a into trunk Feb 12, 2024
57 checks passed
@andrewserong andrewserong deleted the update/clarify-the-intent-behind-the-wp-block-styles-theme-support branch February 12, 2024 22:06
@github-actions github-actions bot added this to the Gutenberg 17.8 milestone Feb 12, 2024
aristath added a commit that referenced this pull request Feb 13, 2024
* trunk: (273 commits)
  Remove preffered style variations legacy support (#58930)
  Style theme variations: add property extraction and merge utils (#58803)
  Migrate `change-detection` to Playwright (#58767)
  Update Changelog for 17.6.6
  Docs: Clarify the status of the wp-block-styles theme support, and its intent (#58915)
  Use `data_wp_context` helper in core blocks and remove `data-wp-interactive` object (#58943)
  Try double enter for details block. (#58903)
  Template revisions API: move from experimental to compat/6.4 (#58920)
  Editor: Remove inline toolbar preference (#58945)
  Clean up link control CSS. (#58934)
  Font Library: Show error message when no fonts found to install (#58914)
  Block Bindings: lock editing of blocks by default (#58787)
  Editor: Remove the 'all' rendering mode (#58935)
  Pagination Numbers: Add `data-wp-key` to pagination numbers if enhanced pagination is enabled (#58189)
  Close link preview if collapsed selection when creating link (#58896)
  Fix incorrect useAnchor positioning when switching from virtual to rich text elements (#58900)
  Upgrade Floating UI packages, fix nested iframe positioning bug (#58932)
  Site editor: fix start patterns store selector (#58813)
  Revert "Rich text: pad multiple spaces through en/em replacement (#56341)" (#58792)
  Documentation: Clarify the performance reference commit and how to pick it (#58927)
  ...
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