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] Getting Started > Reading this handbook #847

Closed
Tracked by #816 ...
justintadlock opened this issue Jun 1, 2023 · 10 comments
Closed
Tracked by #816 ...
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 "Reading this handbook" under Chapter 1: Getting Started.

I will draft the content for the new page in a Google Doc: https://docs.google.com/document/d/1XoxapCQ3uCus0tr7V40lgrJ-dMPDIZIY55Fus_ocMKc/edit?usp=sharing

Some early thoughts: I'll draft this separately, but it might be worth exploring combining this page and the "Who is this handbook for?" page: #845. This isn't in need of an urgent decision, but I wanted to make a quick note of it for later

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

github-actions bot commented Jun 1, 2023

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

@zzap
Copy link
Member

zzap commented Jun 1, 2023

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

@justintadlock
Copy link
Author

The first draft of this documentation is finished and ready for review: https://docs.google.com/document/d/1XoxapCQ3uCus0tr7V40lgrJ-dMPDIZIY55Fus_ocMKc/edit?usp=sharing

Important notes:

  • This will need a link review before it can go live. The page currently has several links that point to pages that have not been published yet.
  • It is likely that this page will need a few edits as we move along in the handbook overhaul process. It is providing pathways for reading the handbook in the first section, which could potentially change. The current format is based upon the overall outline of the new handbook, but this is something to keep in mind as we get closer to publishing.

@kafleg
Copy link
Member

kafleg commented Jun 7, 2023

The first draft of this documentation is finished and ready for review: https://docs.google.com/document/d/1XoxapCQ3uCus0tr7V40lgrJ-dMPDIZIY55Fus_ocMKc/edit?usp=sharing

Important notes:

  • This will need a link review before it can go live. The page currently has several links that point to pages that have not been published yet.
  • It is likely that this page will need a few edits as we move along in the handbook overhaul process. It is providing pathways for reading the handbook in the first section, which could potentially change. The current format is based upon the overall outline of the new handbook, but this is something to keep in mind as we get closer to publishing.

Looks good. It is ready to go.

@carolinan
Copy link
Collaborator

Thank you, I've left some comments. I think the switch from "Your next steps" directly to "What is a namespace" may be a bit steep?

@justintadlock
Copy link
Author

I reworked that last section to be more focused on "reading code examples."

@carolinan
Copy link
Collaborator

Looks good to me, thank you.

@justintadlock
Copy link
Author

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

@kafleg
Copy link
Member

kafleg commented Nov 21, 2023

LGTM

@justintadlock
Copy link
Author

@github-actions github-actions bot added the [Status] Done Issue is completed label Nov 21, 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

4 participants