-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Keep "theme.json" properties documentation properly updated in the handbooks while avoid duplicate themes content in Block Editor Handbook and Theme Handbook #56499
Comments
Hey @juanmaguitar @justintadlock ! So thankful I found your issue while trying to figure out why I couldn't find some things in the main/latest theme.json reference. Agreed that there is too much content spread across too many locations, to the point of being very difficult to find (or you start doubting yourself that an option ever existed in your memory, ha!). It's a bit confusing to know when a developer is supposed to refer to the Block Editor Handbook vs the Theme Handbook: EXAMPLE: LOCATION 1 & THE ISSUE:BLOCK EDITOR HANDBOOK > REFERENCES GUIDES > THEME.JSON REFERENCE > Theme.json Version 3 Reference (latest) BLOCK EDITOR HANDBOOK > REFERENCES GUIDES > THEME.JSON REFERENCE > AVAILABLE STYLES OPTIONS (Aside: blocks are mentioned here and the way they should be notated in Theme.json (ie: core/block-name) and a great place to see Attributes available to it, but not in a table as in Styles Options and not in the context of where they can be used in theme.json: https://developer.wordpress.org/block-editor/reference-guides/core-blocks/) Schema: https://raw.githubusercontent.com/WordPress/gutenberg/trunk/schemas/json/theme.json LOCATION 2:elements and blocks are mentioned if you drill down into these sections THEME HANDBOOK > GLOBAL SETTINGS AND STYLES (theme.json) > SETTINGS THEME HANDBOOK > GLOBAL SETTINGS AND STYLES (theme.json) > SETTINGS > BLOCKS THEME HANDBOOK > GLOBAL SETTINGS AND STYLES (theme.json) > STYLES THEME HANDBOOK > GLOBAL SETTINGS AND STYLES (theme.json) > STYLES > APPLYING STYLES not mentioned here: THEME HANDBOOK > GLOBAL SETTINGS AND STYLES (theme.json) > STYLES > SETTINGS REFERENCE THEME HANDBOOK > GLOBAL SETTINGS AND STYLES (theme.json) > STYLES > STYLE REFERENCE LOCATION 3:BLOCK EDITOR HANDBOOK > HOW-TO-GUIDES > THEMES > GLOBAL SETTINGS & STYLES (theme.json) CONCLUSIONWe should mention elements and blocks in the Block Editor handbook (if this is the preferred way of the future), Theme.json reference, and Schema if they are available and referenced elsewhere. Otherwise I imagine others will, as I do, find themselves having all of these tabs open plus @carolinan wonderful page to cross-reference: https://fullsiteediting.com/lessons/creating-theme-json/ (mentions elements) Mentions setting & styling blocks in theme.json: https://fullsiteediting.com/lessons/global-styles/ Here she even lists ALL the elements available inside theme.json: https://fullsiteediting.com/lessons/theme-json-elements/ |
Shape the section Block Editor Handbook / Reference Guides / Theme.json Reference to take into account the new Global Settings and Styles (theme.json) available from the Theme Handbook.
The purpose of this work is to avoid duplication of information and provide the required cross-sites references (Block Editor Handbook <> Themes Handbook)
Some ideas related to this work provided by @justintadlock
Some flags related to this work raised by @bph
The text was updated successfully, but these errors were encountered: