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

Twenty Twenty-Three: User Support Guide #441

Closed
5 tasks done
kathrynwp opened this issue Sep 11, 2022 · 20 comments
Closed
5 tasks done

Twenty Twenty-Three: User Support Guide #441

kathrynwp opened this issue Sep 11, 2022 · 20 comments
Assignees
Labels
6.1 Changes in 6.1 release high priority new document Requests for new page/article. user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@kathrynwp
Copy link

kathrynwp commented Sep 11, 2022

What is the new page you are requesting?

A user guide for the Twenty Twenty-Three theme and its style variations.

How will this new page help you?

With a new default theme coming with WordPress 6.1, users will find a getting-started guide helpful. It could include information like:

  • How Twenty Twenty-Three works with Full Site Editing, including what templates and patterns are included
  • How style variations work and what the included style variations look like
  • How to make common customizations
  • An overview of some of the features in TT3 that take advantage of WP 6.1 improvements, such as fluid typography

In terms of the format, we can draw inspiration from this existing guide for TT2:

https://wordpress.org/support/article/twenty-twenty-two/

General

  • Make sure all screenshots are relevant to the latest version
  • Make sure videos are up to date, if any
  • Add ALT tags for the images
  • Make sure the headings are in sentence case
  • Convert all reusable blocks to a ‘regular block’.
@kathrynwp kathrynwp added the new document Requests for new page/article. label Sep 11, 2022
@bph bph added the user documentation (HelpHub) Improvements or additions to end-user documentation label Sep 11, 2022
@github-actions
Copy link

Heads up @femkreations @atachibana - the "user documentation" label was applied to this issue.

@kathrynwp
Copy link
Author

kathrynwp commented Oct 12, 2022

Here is the draft article:

https://wordpress.org/support/?post_type=helphub_article&p=16093494&preview=true

@femkreations Let me know what you think so far, this is my first time writing a support article for WP.org.

Thanks to TT3 development lead Sarah Norris (@mikachan) for feedback on the first draft, and @annezazu for inspiration taken from her Twenty Twenty-Two support article!

@femkreations
Copy link
Collaborator

@kathrynwp This looks great. Thanks for your work.

  • Pls also add that this is the first default block theme marked as accessibility-ready as noted by Ann in this article -under Themes.
  • Remove the reference to Twenty Twenty-Two in the first line.

Other than that, great job with the article. Please add screenshots for the Patterns and links and we are good to go.

@femkreations
Copy link
Collaborator

@kathrynwp I have also added a checklist that we normally follow when writing articles (See the description under General) Let me know if you have any questions. Thanks

@kathrynwp
Copy link
Author

@femkreations Thanks for having a look so quickly!

Remove the reference to Twenty Twenty-Two in the first line.

Oops, good catch, fixed.

Pls also add that this is the first default block theme marked as accessibility-ready as noted by Ann in this article -under Themes.

Looks like TT2 was also accessibility-ready, so what do you think about this revision to the first line:

Twenty Twenty-Three is the new, accessibility-ready, default theme for WordPress Version 6.1

Will add more screenshots and let you know when they're there.

I have also added a checklist that we normally follow when writing articles

Great, I'll be sure to double-check that all those are adhered to. Thanks!

@annezazu
Copy link
Collaborator

Twenty Twenty-Three is the new, accessibility-ready, default theme for WordPress Version 6.1

This sounds great to me for what it's worth.

Twenty Twenty-Three is the first default theme to incorporate a collection of style variations submitted by community members

Of note, Twenty Twenty-Two has bundled style variations in place as of WordPress 6.0! However, this is the first community submitted style variations so this statement is both true in a sense but a bit confusing. I might simplify it to: "Twenty Twenty-Three is the first default theme to incorporate a collection of community submitted style variations" or "Twenty Twenty-Three incorporates a collection of ten community submitted style variations".

@femkreations
Copy link
Collaborator

Twenty Twenty-Three incorporates a collection of ten community submitted style variations".

Thanks for clarifying Ann. I'd go with this version just for simplicity.
"Twenty Twenty-Three includes a collection of ten community-submitted style variations."

@kathrynwp
Copy link
Author

Thank you, @femkreations and @annezazu! I've made that wording update.

@kathrynwp
Copy link
Author

kathrynwp commented Oct 24, 2022

@femkreations I've added a bunch of screenshots to the document.

@mikachan would you please be able to:

  • in the gallery of style images, double-check that the most up-to-date style variation name is assigned to each variation screenshot
  • let me know if the word "Default" is OK for the caption on the default style, or if there's some other preferred name, or if the caption should be left blank
  • let me know if you think the style creators should be credited anywhere, as they were in the announcement doc. (This could be in the captions, or in a list below the screenshots, perhaps.)
  • confirm whether all screenshots match the final state of the theme closely enough

@femkreations re: "Make sure the headings are in sentence case" - the Twenty Twenty-Two doc, on which this one is based, uses title case for headings. (i.e. "Color Palette," "Full Site Editing Support") Could you please confirm what you'd like for this one?

@kathrynwp
Copy link
Author

@annezazu also mentioned that there is a new TT3 video coming out soon, so we may want to embed that in the doc as well.

@mikachan
Copy link
Member

👋 I don't seem to have access to https://wordpress.org/support/?post_type=helphub_article&p=16093494&preview=true, is that where I should be looking? I think I can answer some of the points without seeing the latest version of the guide:

let me know if the word "Default" is OK for the caption on the default style, or if there's some other preferred name, or if the caption should be left blank

Using "Default" for the default style sounds fine to me. We have sometimes referred to it as the base theme, but I don't think this is a standard name and may be confusing.

let me know if you think the style creators should be credited anywhere, as they were in the announcement doc. (This could be in the captions, or in a list below the screenshots, perhaps.)

Yeah, I think this would be great. Without seeing the guide itself, adding credits to the captions sounds like a nice way to do this.

@kathrynwp
Copy link
Author

@mikachan Thanks for the quick reply, and I'm sorry about the lack of access, totally overlooked that! Here's a screenshot you can peek at, let me know if this works well enough:

whole-page-screenshot

@mikachan
Copy link
Member

No worries, thanks for adding the screenshot!

in the gallery of style images, double-check that the most up-to-date style variation name is assigned to each variation screenshot

Yes, all these names look correct to me 👍 I think "Default" works well here too.

confirm whether all screenshots match the final state of the theme closely enough

The styles in the screenshots look up to date (colours, fonts), however, some of the screenshots include the "Latest Posts" and "View more" headings above the query loop, which have since been removed. The text is extremely tiny, so possibly difficult to notice, but it is different compared to the current layout. It looks like these are included on Default, Canary, Electric, Marigold, Grapes, Aubergine, Whisper and Sherbet.

Screenshot 2022-10-26 at 10 12 22

@kathrynwp
Copy link
Author

@mikachan Thank you for all the feedback!

  • I've kept "Default"
  • I've added creator names to the captions for the 10 style variations. Here's a screenshot of what that now looks like:

Twenty_Twenty-Three_–_WordPress_org_Forums

  • I'm looking into the issue with the "Latest Posts" and "View more" headings

@mikachan
Copy link
Member

Thank you, this looks good to me!

I'm looking into the issue with the "Latest Posts" and "View more" headings

I don't feel strongly about this, it's a very minor detail.

@kathrynwp
Copy link
Author

@mikachan OK sounds good!

One more thing that will be added is a new TT3 video that @beafialho is working on. I'll embed it in the doc once it's ready.

@kathrynwp
Copy link
Author

kathrynwp commented Oct 31, 2022

@femkreations Hey there! I think this is pretty much ready to go as soon as 6.1 is live. I was still wondering if you wanted to clarify about the sentence-case question I had above, otherwise I'll leave things as is. Thank you!

I'll add the captioned video whenever it's ready, possibly Wednesday.

I'll also check all the links once everything goes live.

@femkreations
Copy link
Collaborator

@kathrynwp Thanks so much for working on this page and doing a fabulous job. We use sentence cases on headings as a guide. So Color Palette is Color palette, Full Site Editing support etc. Hope that clarifies. Its a minor change.

@kathrynwp
Copy link
Author

@femkreations Thanks for confirming, I've made the update!

@kathrynwp
Copy link
Author

The new page is now live!

https://wordpress.org/support/article/twenty-twenty-three/

I'll be dropping in the new TT3 video as soon as it's ready, but I'll go ahead and close this out for now.

Repository owner moved this from In Progress to Done in WP 6.1 Documentation Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.1 Changes in 6.1 release high priority new document Requests for new page/article. user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
Status: Done
Development

No branches or pull requests

5 participants