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] Publish Chapter 3: Global Settings and Styles #1131

Open
23 tasks done
justintadlock opened this issue Sep 28, 2023 · 5 comments
Open
23 tasks done
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation new document Requests for new page/article. themes Issues for Theme Developer Handbook

Comments

@justintadlock
Copy link

justintadlock commented Sep 28, 2023

Now that the Global Settings and Styles (theme.json) chapter is fully drafted, it is time to begin moving this new chapter to the Theme Handbook.

This is a sub-tracking issue for #816. I've created this ticket so that it's easier to manage and coordinate the process for this extremely large new chapter that is being added. We can also use this to add any notes for things we need to know as we move through the larger Theme Handbook Overhaul project.

Note that this is the first chapter to be published, as outlined in Theme Handbook Overhaul: Phase 3 (Publishing Content). Chapters 1 and 2 rely on later chapters to be published first. Chapter 3 is the first self-contained chapter, which is why we are using it as a starting point.

Docs to publish

Each of these docs need to be added as drafts in the Theme Handbook. Then, when ready, publish them.

To be published with Chapter 4: Templates

Two of the docs drafted for this chapter should be published alongside the Templates chapter. These docs link directly to the Templates chapter, which is a part of their learning pathway.

Older Content

This new chapter is replacement for these articles in the current handbook:

There is no current decision on how to handle older content. My recommendation for this is:

  • Remove the current doc from the navigation but leave published.
  • Replace the current doc's content with an Notice block that points readers to the new chapter at https://developer.wordpress.org/themes/global-settings-and-styles/.

Example content for the Notice block:

This article has now been replaced with a dedicated Global Settings and Styles chapter in the Theme Handbook.

@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 Sep 28, 2023
@justintadlock justintadlock self-assigned this Sep 28, 2023
@github-actions
Copy link

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

@github-actions
Copy link

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

@justintadlock
Copy link
Author

All of these (except the templates docs, which are waiting for the Templates chapter) are now in the Theme Handbook system. I'll go through and publish these once I get the 👍 and do any final link checks.

@justintadlock
Copy link
Author

This chapter is now live in the handbook. I'm leaving this ticket open for a bit for folks to report any issues, especially since this is a large chapter with loads of docs.

@justintadlock
Copy link
Author

Probably need a section for gotchas, issues, and other theme.json styling issues like this: WordPress/gutenberg#55644

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. themes Issues for Theme Developer Handbook
Projects
None yet
Development

No branches or pull requests

1 participant