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] Features > Block Patterns #1141

Closed
Tracked by #816 ...
justintadlock opened this issue Oct 5, 2023 · 6 comments
Closed
Tracked by #816 ...

[Theme Handbook Overhaul] Features > Block Patterns #1141

justintadlock opened this issue Oct 5, 2023 · 6 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

This ticket is a part of #816 and will be used for creating new page titled "Block Patterns" under Chapter 5: Features.

The content for the new page will be drafted in a Google Doc:https://docs.google.com/document/d/1Zir3QD5ednCkdbNmsuTvvaVAIHgieAiOIN-N8v0IKXg/edit?usp=sharing

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

github-actions bot commented Oct 5, 2023

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

@github-actions
Copy link

github-actions bot commented Oct 5, 2023

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

@justintadlock
Copy link
Author

justintadlock commented Oct 6, 2023

This draft is now complete and can be reviewed.

Notes

Honestly, I think a single document cannot truly cover everything that's possible with patterns. As it stands, this initial draft is 3,600+ words. That's about the equivalent of a 14 or 15-page printed paper, so it's pretty big. I really don't like going that big with one doc because you tend to lose the reader, and it becomes harder to find what you're looking for, even with a Table of Contents.

While I think I hit most of the major points, there's still so much more to cover. In the long term, I believe we'll benefit from splitting this into multiple sub-pages that goes into even more details. Something along these lines:

  • Block Patterns: intro page that covers patterns in more detail, especially diving into various states and UI parts.
    • A sub-page that dives into building, registering, and unregistering patterns.
    • A sub-page that goes over things like internationalization, including assets, template locking, and other tips/tricks.
    • A sub-page that covers pattern categories.

For the short term as we get this handbook overhaul moving forward, I think we can stick with a single doc.

@justintadlock
Copy link
Author

The draft for this in the Theme Handbook: https://developer.wordpress.org/wp-admin/post.php?post=149262&action=edit

@kafleg
Copy link
Member

kafleg commented Nov 6, 2023

Looks good to me.

@justintadlock
Copy link
Author

This doc is now published here: https://developer.wordpress.org/themes/features/block-patterns/

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

2 participants