Formatting standards for the site.

WordPress / developer-blog-content

In this GitHub space, WordPress team coordinate content to be published on the Developer Blog. Discussion and montly meetings (first Thu) in WP Slack #core-dev-blog

36 stars 2 forks source link

Formatting standards for the site. #241

Open bph opened 3 months ago

bph commented 3 months ago

Notes

Follow Heading hierarchy on Google Doc comes over well into the Block editor
Table of Contents is a pattern found in the Developer Blog category
Use the the Notice Alert block or call-outs like special information, warnings.
Code Block is in flux right now, don't add a language.
Props are right aligned and italics

bph commented 2 months ago

Featured image notes:

ironnysh commented 2 months ago

I've just prepared my first post for publication. It went pretty smoothly, but thought I'd share a few suggestions for potential time-savers:

Create a couple of templates for common post types (code-heavy tutorials, What's new, etc.). This way, the ToC and Props section are already there, as well as the Code and Notice blocks.
Provide technical guidelines for social copy and a template for the featured image.
Clarify the external links policy (this post is old and incomplete).
Editor-level users can't see the full tags list, so unless you're covered by the Most used, it's a guessing game.
Make the pre- / post-publishing checklist clickable.
Consider adding the Playground Block to the site ;-)

bph commented 2 months ago

All good calls. Thank you @ironnysh

bph commented 1 month ago

Add UI references in bold (not quotes) from the Documentation Style Guide
How to format links <a href="URL">text description phrase, probably title of the post/page titlle</a> for resource lists. inline of the prose also use a descriptive phrase don't just use "here" links. please. They are really bad for accessiblity.

bph commented 3 weeks ago

Update on Featured Image: the design team is working on Thumbnail / Featured image set for the Developer blog in Figma. And then writers can follow the tutorial on how to modify the template for their post.

From the Design share

Generating thumbnail images, a step-by-step video

In collaboration with Kathryn Presner, we recorded a video showing step by step how to generate visuals for WordPress-related videos with the video thumbnail generator file. The file will be public in Figma Community once this video reaches WordPress YouTube channel, but so far, it’s already public on WordPress TV.