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

[Theme Handbook Overhaul] Global Settings and Styles > Settings > Settings Reference #987

Closed
Tracked by #816 ...
justintadlock opened this issue Jul 28, 2023 · 12 comments
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. [Status] Done Issue is completed themes Issues for Theme Developer Handbook

Comments

@justintadlock
Copy link

justintadlock commented Jul 28, 2023

This ticket is a part of #816 and will be used for creating new page titled "Settings Reference" under Chapter 3: Global Settings and Styles > Settings.

@tinjure20 and I have been discussing what this might look like and will begin working on a new page soon. Initial Google Doc will be added next week.

@justintadlock justintadlock added developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. themes Issues for Theme Developer Handbook labels Jul 28, 2023
@justintadlock justintadlock self-assigned this Jul 28, 2023
@github-actions
Copy link

Heads up @kafleg @carolinan @TeBenachi - the "themes" label was applied to this issue.

@tinjure20
Copy link

@justintadlock Thanks for creating ticket as discussed. Let's work together on this ticket.

@justintadlock
Copy link
Author

I've created a Google Doc that we can work from here: https://docs.google.com/document/d/1DeQ7iM19J8a7Zs_lAZ_HRIga5hyKOTXmhlzXZrKiVkE/edit?usp=sharing

@tinjure20
Copy link

Given that this is still a work-in-progress copy, I have added a few tables from my notes, which I'd prepared a while back. I have not had a chance to check and verify with recent updates.

@justintadlock
Copy link
Author

After chatting with @tinjure20, we decided to split this up into two separate docs:

  • Settings Reference
  • Styles Reference

Given the separation of the Settings and Styles sections in the current chapter outline, this makes a lot more sense. Plus, it should be easier for readers to follow by shortening the individual docs.

I'm in the process of splitting these into two separate docs and rearranging this a bit in the tracking ticket.

@justintadlock justintadlock changed the title [Theme Handbook Overhaul] Global Settings and Styles > Reference Table [Theme Handbook Overhaul] Global Settings and Styles > Settings > Settings Reference Sep 19, 2023
@justintadlock
Copy link
Author

I've left this ticket open and renamed it as the primary Settings Reference ticket.

For the Styles Reference doc, I've created a separate ticket: #1120

@justintadlock
Copy link
Author

I've went through this, cleaned it up a bit (mostly narrowing it down to the necessary things), linked out to the new theme.json doc pages, etc.

It should be ready to review at this point.

@justintadlock
Copy link
Author

This is now a draft for the Theme Handbook: https://developer.wordpress.org/wp-admin/post.php?post=149100&action=edit

@ouw-jvt
Copy link

ouw-jvt commented Oct 12, 2023

There are a few settings that must be explicitly set values (not references or css variables) due to the way they are digested by the PHP side of things. It would be helpful to denote this in this reference, perhaps as another column. "Supports references" - something like that?

Related to these issues in the Gutenberg tracker:

@justintadlock
Copy link
Author

I'd prefer to avoid extra table columns just based on the current handbook design (a new design is in progress). However, I think we can add a Notice block to specifically point out those for the time being since it'd be just two notes.

@ouw-jvt
Copy link

ouw-jvt commented Oct 12, 2023

That would be excellent, thanks!

@justintadlock
Copy link
Author

@github-actions github-actions bot added the [Status] Done Issue is completed label Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. [Status] Done Issue is completed themes Issues for Theme Developer Handbook
Projects
None yet
Development

No branches or pull requests

3 participants